AnalyzeContentResponse

JSON representation
OutputAudio
- JSON representation
AutomatedAgentReply
- JSON representation
AutomatedAgentReplyType
SuggestionResult
- JSON representation
DtmfParameters
- JSON representation

The response message for Participants.AnalyzeContent .

JSON representation

JSON representation
{ "replyText" : string , "replyAudio" : { object ( `OutputAudio` ) } , "automatedAgentReply" : { object ( `AutomatedAgentReply` ) } , "message" : { object ( `Message` ) } , "humanAgentSuggestionResults" : [ { object ( `SuggestionResult` ) } ] , "endUserSuggestionResults" : [ { object ( `SuggestionResult` ) } ] , "dtmfParameters" : { object ( `DtmfParameters` ) } }

 { 
 "replyText" 
 : 
 string 
 , 
 "replyAudio" 
 : 
 { 
 object (  OutputAudio 
 
) 
 } 
 , 
 "automatedAgentReply" 
 : 
 { 
 object (  AutomatedAgentReply 
 
) 
 } 
 , 
 "message" 
 : 
 { 
 object (  Message 
 
) 
 } 
 , 
 "humanAgentSuggestionResults" 
 : 
 [ 
 { 
 object (  SuggestionResult 
 
) 
 } 
 ] 
 , 
 "endUserSuggestionResults" 
 : 
 [ 
 { 
 object (  SuggestionResult 
 
) 
 } 
 ] 
 , 
 "dtmfParameters" 
 : 
 { 
 object (  DtmfParameters 
 
) 
 } 
 }

Fields

replyText

string

The output text content. This field is set if the automated agent responded with text to show to the user.

replyAudio

object ( OutputAudio )

The audio data bytes encoded as specified in the request. This field is set if:

replyAudioConfig was specified in the request, or
The automated agent responded with audio to play to the user. In such case, replyAudio.config contains settings used to synthesize the speech.

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.

automatedAgentReply

object ( AutomatedAgentReply )

Only set if a Dialogflow automated agent has responded. Note that in [AutomatedAgentReply.DetectIntentResponse][], [Sessions.DetectIntentResponse.output_audio][] and [Sessions.DetectIntentResponse.output_audio_config][] are always empty, use replyAudio instead.

message

object ( Message )

Message analyzed by CCAI.

humanAgentSuggestionResults[]

object ( SuggestionResult )

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config .

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.

endUserSuggestionResults[]

object ( SuggestionResult )

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config .

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.

dtmfParameters

object ( DtmfParameters )

Indicates the parameters of DTMF.

OutputAudio

Represents the natural language speech audio to be played to the end user.

JSON representation
{ "config" : { object ( `OutputAudioConfig` ) } , "audio" : string }

Fields

Fields
`config`	`object ( OutputAudioConfig )` Instructs the speech synthesizer how to generate the speech audio.
`audio`	`string ( bytes format)` The natural language speech audio. A base64-encoded string.

config

object ( OutputAudioConfig )

Instructs the speech synthesizer how to generate the speech audio.

audio

string ( bytes format)

The natural language speech audio.

A base64-encoded string.

AutomatedAgentReply

Represents a response from an automated agent.

JSON representation
{ "detectIntentResponse" : { object ( `DetectIntentResponse` ) } , "automatedAgentReplyType" : enum ( `AutomatedAgentReplyType` ) , "allowCancellation" : boolean , "cxCurrentPage" : string }

Fields
`detectIntentResponse`	`object ( DetectIntentResponse )` Response of the Dialogflow `Sessions.DetectIntent` call.
`automatedAgentReplyType`	`enum ( AutomatedAgentReplyType )` AutomatedAgentReply type.
`allowCancellation`	`boolean` 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.
`cxCurrentPage`	`string` The unique identifier of the current Dialogflow CX conversation page. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>` .

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

JSON representation
{ // Union field `suggestion_response` can be only one of the following: "error" : { object ( `Status` ) } , "suggestArticlesResponse" : { object ( `SuggestArticlesResponse` ) } , "suggestKnowledgeAssistResponse" : { object ( `SuggestKnowledgeAssistResponse` ) } , "suggestFaqAnswersResponse" : { object ( `SuggestFaqAnswersResponse` ) } , "suggestSmartRepliesResponse" : { object ( `SuggestSmartRepliesResponse` ) } , "generateSuggestionsResponse" : { object ( `GenerateSuggestionsResponse` ) } // End of list of possible types for union field `suggestion_response` . }

 { 
 // Union field suggestion_response 
can be only one of the following: 
 "error" 
 : 
 { 
 object (  Status 
 
) 
 } 
 , 
 "suggestArticlesResponse" 
 : 
 { 
 object (  SuggestArticlesResponse 
 
) 
 } 
 , 
 "suggestKnowledgeAssistResponse" 
 : 
 { 
 object (  SuggestKnowledgeAssistResponse 
 
) 
 } 
 , 
 "suggestFaqAnswersResponse" 
 : 
 { 
 object (  SuggestFaqAnswersResponse 
 
) 
 } 
 , 
 "suggestSmartRepliesResponse" 
 : 
 { 
 object (  SuggestSmartRepliesResponse 
 
) 
 } 
 , 
 "generateSuggestionsResponse" 
 : 
 { 
 object (  GenerateSuggestionsResponse 
 
) 
 } 
 // End of list of possible types for union field suggestion_response 
. 
 }