- JSON representation
- OutputAudio
- AutomatedAgentReply
- AutomatedAgentReplyType
- SuggestionResult
- SuggestDialogflowAssistsResponse
- DtmfParameters
The response message for Participants.AnalyzeContent
.
JSON representation |
---|
{ "replyText": string, "replyAudio": { object ( |
Fields | |
---|---|
reply |
Output only. The output text content. This field is set if the automated agent responded with text to show to the user. |
reply |
Optional. The audio data bytes encoded as specified in the request. This field is set if:
In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content. |
automated |
Optional. Only set if a Dialogflow automated agent has responded. Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] and [AutomatedAgentReply.detect_intent_response.output_audio_config][] are always empty, use |
message |
Output only. Message analyzed by CCAI. |
human |
The suggestions for most recent human agent. The order is the same as Note that any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult. |
end |
The suggestions for end user. The order is the same as Same as humanAgentSuggestionResults, any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult. |
dtmf |
Indicates the parameters of DTMF. |
OutputAudio
Represents the natural language speech audio to be played to the end user.
JSON representation |
---|
{
"config": {
object ( |
Fields | |
---|---|
config |
Required. Instructs the speech synthesizer how to generate the speech audio. |
audio |
Required. The natural language speech audio. A base64-encoded string. |
AutomatedAgentReply
Represents a response from an automated agent.
JSON representation |
---|
{ "responseMessages": [ { object ( |
Fields | |
---|---|
response |
Response messages from the automated agent. |
match |
The confidence of the match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
parameters |
The collection of current parameters at the time of this response. |
cxSessionParameters |
The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use |
automated |
AutomatedAgentReply type. |
allow |
Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled. |
cx |
The unique identifier of the current Dialogflow CX conversation page. Format: |
call |
The auth code for accessing Call Companion UI. A base64-encoded string. |
Union field response . Required. response can be only one of the following: |
|
detect |
Response of the Dialogflow |
Union field match . Info on the query match for the automated agent response. match can be only one of the following: |
|
intent |
Name of the intent if an intent is matched for the query. For a V2 query, the value format is |
event |
Event name if an event is triggered for the query. |
AutomatedAgentReplyType
Represents different automated agent reply types.
Enums | |
---|---|
AUTOMATED_AGENT_REPLY_TYPE_UNSPECIFIED |
Not specified. This should never happen. |
PARTIAL |
Partial reply. e.g. Aggregated responses in a Fulfillment that enables return_partial_response can be returned as partial reply. WARNING: partial reply is not eligible for barge-in. |
FINAL |
Final reply. |
SuggestionResult
One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent
and Participants.AnalyzeContent
, as well as HumanAgentAssistantEvent
.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field suggestion_response . Different type of suggestion response. suggestion_response can be only one of the following: |
|
error |
Error status if the request failed. |
suggest |
SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. |
suggest |
SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. |
suggest |
SuggestFaqAnswersResponse if request is for FAQ_ANSWER. |
suggest |
SuggestSmartRepliesResponse if request is for SMART_REPLY. |
suggest |
SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST. |
suggest |
SuggestDialogflowAssistsResponse if request is for ENTITY_EXTRACTION. |
SuggestDialogflowAssistsResponse
The response message for Participants.SuggestDialogflowAssists
.
JSON representation |
---|
{
"dialogflowAssistAnswers": [
{
object ( |
Fields | |
---|---|
dialogflow |
Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction. |
latest |
The name of the latest conversation message used to suggest answer. Format: |
context |
Number of messages prior to and including |
DtmfParameters
The message in the response that indicates the parameters of DTMF.
JSON representation |
---|
{ "acceptsDtmfInput": boolean } |
Fields | |
---|---|
accepts |
Indicates whether DTMF input can be handled in the next request. |