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.

endUserSuggestionResults[]

object (SuggestionResult)

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

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)
    }
  ],
  "cxSessionParameters": {
    object
  },
  "detectIntentResponse": {
    object (DetectIntentResponse)
  },

  // 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.

cxSessionParameters

object (Struct format)

The collection of current Dialogflow CX agent session parameters at the time of this response.

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)
  }
  // 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.

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

Indicates that interaction with the Dialogflow agent has ended.

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)
  }
  // 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.

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.