AnalyzeContentResponse

The response message for Participants.AnalyzeContent.

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

string

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

object (OutputAudio)

Optional. 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)

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 replyAudio instead.
message

object (Message)

Output only. 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
config

object (OutputAudioConfig)

Required. Instructs the speech synthesizer how to generate the speech audio.
audio

string (bytes format)

Required. The natural language speech audio.

A base64-encoded string.

AutomatedAgentReply

Represents a response from an automated agent.

JSON representation 
{
  "responseMessages": [
    {
      object (ResponseMessage)
    }
  ],
  "matchConfidence": number,
  "parameters": {
    object
  },
  "cxSessionParameters": {
    object
  },
  "automatedAgentReplyType": enum (AutomatedAgentReplyType),
  "allowCancellation": boolean,
  "cxCurrentPage": string,
  "callCompanionAuthCode": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "detectIntentResponse": {
    object (DetectIntentResponse)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "intent": string,
  "event": string
  // End of mutually exclusive fields.
}
Fields
responseMessages[]

object (ResponseMessage)

Response messages from the automated agent.
matchConfidence

number

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

object (Struct format)

The collection of current parameters at the time of this response.
cxSessionParameters
(deprecated)

object (Struct format)

The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use parameters instead.
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>.
callCompanionAuthCode

string (bytes format)

The auth code for accessing Call Companion UI.

A base64-encoded string.
Required. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
detectIntentResponse

object (DetectIntentResponse)

Response of the Dialogflow Sessions.DetectIntent call.
End of mutually exclusive fields.
Info on the query match for the automated agent response. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
intent

string

Name of the intent if an intent is matched for the query. For a V2 query, the value format is projects/<Project ID>/locations/ <Location ID>/agent/intents/<Intent ID>. For a V3 query, the value format is projects/<Project ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.
event

string

Event name if an event is triggered for the query.
End of mutually exclusive fields.

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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "suggestArticlesResponse": {
    object (SuggestArticlesResponse)
  },
  "suggestKnowledgeAssistResponse": {
    object (SuggestKnowledgeAssistResponse)
  },
  "suggestFaqAnswersResponse": {
    object (SuggestFaqAnswersResponse)
  },
  "suggestSmartRepliesResponse": {
    object (SuggestSmartRepliesResponse)
  },
  "suggestDialogflowAssistsResponse": {
    object (SuggestDialogflowAssistsResponse)
  },
  "suggestEntityExtractionResponse": {
    object (SuggestDialogflowAssistsResponse)
  },
  "generateSuggestionsResponse": {
    object (GenerateSuggestionsResponse)
  },
  "generateCompanionSuggestionsResponse": {
    object (GenerateCompanionSuggestionsResponse)
  }
  // End of mutually exclusive fields.
}
Fields
Different type of suggestion response. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
error

object (Status)

Error status if the request failed.
suggestArticlesResponse

object (SuggestArticlesResponse)

SuggestArticlesResponse if request is for ARTICLE_SUGGESTION.
suggestKnowledgeAssistResponse

object (SuggestKnowledgeAssistResponse)

SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST.
suggestFaqAnswersResponse

object (SuggestFaqAnswersResponse)

SuggestFaqAnswersResponse if request is for FAQ_ANSWER.
suggestSmartRepliesResponse

object (SuggestSmartRepliesResponse)

SuggestSmartRepliesResponse if request is for SMART_REPLY.
suggestDialogflowAssistsResponse

object (SuggestDialogflowAssistsResponse)

SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST.
suggestEntityExtractionResponse

object (SuggestDialogflowAssistsResponse)

SuggestDialogflowAssistsResponse if request is for ENTITY_EXTRACTION.
generateSuggestionsResponse

object (GenerateSuggestionsResponse)

Suggestions generated using generators triggered by customer or agent messages.
generateCompanionSuggestionsResponse

object (GenerateCompanionSuggestionsResponse)

Suggestions generated by companion agent.
End of mutually exclusive fields.

SuggestDialogflowAssistsResponse

The response message for Participants.SuggestDialogflowAssists.

JSON representation 
{
  "dialogflowAssistAnswers": [
    {
      object (DialogflowAssistAnswer)
    }
  ],
  "latestMessage": string,
  "contextSize": integer
}
Fields
dialogflowAssistAnswers[]

object (DialogflowAssistAnswer)

Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction.
latestMessage

string

The name of the latest conversation message used to suggest answer.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.
contextSize

integer

Number of messages prior to and including latestMessage to compile the suggestion. It may be smaller than the SuggestDialogflowAssistsRequest.context_size field in the request if there aren't that many messages in the conversation.

GenerateCompanionSuggestionsResponse

Represents the response message for GenerateCompanionSuggestions.

JSON representation 
{
  "companionSuggestion": {
    object (CompanionSuggestion)
  },
  "answerRecord": string,
  "latestMessage": string,
  "suggestionIndex": integer
}
Fields
companionSuggestion

object (CompanionSuggestion)

Contains the core suggestion generated by the Companion Agent.
answerRecord

string

Answer record that uniquely identifies the suggestion. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.
latestMessage

string

The name of the latest conversation message used to compile suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.
suggestionIndex

integer

Output only. The 1-based sequential index of the suggestion generated in this session.

DtmfParameters

The message in the response that indicates the parameters of DTMF.

JSON representation 
{
  "acceptsDtmfInput": boolean
}
Fields
acceptsDtmfInput

boolean

Indicates whether DTMF input can be handled in the next request.