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,

  // Union field response can be only one of the following:
  "detectIntentResponse": {
    object (DetectIntentResponse)
  }
  // End of list of possible types for union field response.

  // Union field match can be only one of the following:
  "intent": string,
  "event": string
  // End of list of possible types for union field match.
}
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>.
Union field response. Required. response can be only one of the following:
detectIntentResponse

object (DetectIntentResponse)

Response of the Dialogflow Sessions.DetectIntent call.
Union field match. Info on the query match for the automated agent response. match can be only one of the following:
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.

ResponseMessage

Response messages from an automated agent.

JSON representation 
{

  // Union field message can be only one of the following:
  "text": {
    object (Text)
  },
  "payload": {
    object
  },
  "liveAgentHandoff": {
    object (LiveAgentHandoff)
  },
  "endInteraction": {
    object (EndInteraction)
  },
  "mixedAudio": {
    object (MixedAudio)
  },
  "telephonyTransferCall": {
    object (TelephonyTransferCall)
  }
  // End of list of possible types for union field message.
}
Fields
Union field message. Required. The rich response message. message can be only one of the following:
text

object (Text)

Returns a text response.
payload

object (Struct format)

Returns a response containing a custom, platform-specific payload.
liveAgentHandoff

object (LiveAgentHandoff)

Hands off conversation to a live agent.
endInteraction

object (EndInteraction)

A signal that indicates the interaction with the Dialogflow agent has ended.
mixedAudio

object (MixedAudio)

An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.
telephonyTransferCall

object (TelephonyTransferCall)

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

Text

The text response message.

JSON representation 
{
  "text": [
    string
  ]
}
Fields
text[]

string

A collection of text responses.

LiveAgentHandoff

Indicates that the conversation should be handed off to a human agent.

Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.

You may set this, for example:

  • In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation.
  • In a webhook response when you determine that the customer issue can only be handled by a human.
JSON representation 
{
  "metadata": {
    object
  }
}
Fields
metadata

object (Struct format)

Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

EndInteraction

This type has no fields.

Indicates that interaction with the Dialogflow agent has ended.

MixedAudio

Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.

JSON representation 
{
  "segments": [
    {
      object (Segment)
    }
  ]
}
Fields
segments[]

object (Segment)

Segments this audio response is composed of.

Segment

Represents one segment of audio.

JSON representation 
{
  "allowPlaybackInterruption": boolean,

  // Union field content can be only one of the following:
  "audio": string,
  "uri": string
  // End of list of possible types for union field content.
}
Fields
allowPlaybackInterruption

boolean

Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
Union field content. Content of the segment. content can be only one of the following:
audio

string (bytes format)

Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.

A base64-encoded string.
uri

string

Client-specific URI that points to an audio clip accessible to the client.

TelephonyTransferCall

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.

JSON representation 
{

  // Union field endpoint can be only one of the following:
  "phoneNumber": string,
  "sipUri": string
  // End of list of possible types for union field endpoint.
}
Fields
Union field endpoint. Endpoint to transfer the call to. endpoint can be only one of the following:
phoneNumber

string

Transfer the call to a phone number in E.164 format.
sipUri

string

Transfer the call to a SIP endpoint.

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 suggestion_response can be only one of the following:
  "error": {
    object (Status)
  },
  "suggestArticlesResponse": {
    object (SuggestArticlesResponse)
  },
  "suggestFaqAnswersResponse": {
    object (SuggestFaqAnswersResponse)
  },
  "suggestSmartRepliesResponse": {
    object (SuggestSmartRepliesResponse)
  },
  "suggestDialogflowAssistsResponse": {
    object (SuggestDialogflowAssistsResponse)
  },
  "suggestEntityExtractionResponse": {
    object (SuggestDialogflowAssistsResponse)
  }
  // End of list of possible types for union field suggestion_response.
}
Fields
Union field suggestion_response. Different type of suggestion response. suggestion_response can be only one of the following:
error

object (Status)

Error status if the request failed.
suggestArticlesResponse

object (SuggestArticlesResponse)

SuggestArticlesResponse if request is for ARTICLE_SUGGESTION.
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.

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.

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.