Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::AnalyzeContentResponse (v1.5.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::AnalyzeContentResponse.

The response message for Participants.AnalyzeContent.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#automated_agent_reply

def automated_agent_reply() -> ::Google::Cloud::Dialogflow::V2::AutomatedAgentReply

Returns

(::Google::Cloud::Dialogflow::V2::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 reply_audio instead.

#automated_agent_reply=

def automated_agent_reply=(value) -> ::Google::Cloud::Dialogflow::V2::AutomatedAgentReply

Parameter

value (::Google::Cloud::Dialogflow::V2::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 reply_audio instead.

Returns

(::Google::Cloud::Dialogflow::V2::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 reply_audio instead.

#dtmf_parameters

def dtmf_parameters() -> ::Google::Cloud::Dialogflow::V2::DtmfParameters

Returns

(::Google::Cloud::Dialogflow::V2::DtmfParameters) — Indicates the parameters of DTMF.

#dtmf_parameters=

def dtmf_parameters=(value) -> ::Google::Cloud::Dialogflow::V2::DtmfParameters

Parameter

value (::Google::Cloud::Dialogflow::V2::DtmfParameters) — Indicates the parameters of DTMF.

Returns

(::Google::Cloud::Dialogflow::V2::DtmfParameters) — Indicates the parameters of DTMF.

#end_user_suggestion_results

def end_user_suggestion_results() -> ::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>

Returns

(::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>) — The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

Same as human_agent_suggestion_results, 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_user_suggestion_results=

def end_user_suggestion_results=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>

Parameter

value (::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>) — The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

Same as human_agent_suggestion_results, 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.

Returns

(::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>) — The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

Same as human_agent_suggestion_results, 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.

#human_agent_suggestion_results

def human_agent_suggestion_results() -> ::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>

Returns

(::Array<::Google::Cloud::Dialogflow::V2::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.

#human_agent_suggestion_results=

def human_agent_suggestion_results=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>

Parameter

value (::Array<::Google::Cloud::Dialogflow::V2::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.

Returns

(::Array<::Google::Cloud::Dialogflow::V2::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.

#message

def message() -> ::Google::Cloud::Dialogflow::V2::Message

Returns

(::Google::Cloud::Dialogflow::V2::Message) — Message analyzed by CCAI.

#message=

def message=(value) -> ::Google::Cloud::Dialogflow::V2::Message

Parameter

value (::Google::Cloud::Dialogflow::V2::Message) — Message analyzed by CCAI.

Returns

(::Google::Cloud::Dialogflow::V2::Message) — Message analyzed by CCAI.

#reply_audio

def reply_audio() -> ::Google::Cloud::Dialogflow::V2::OutputAudio

Returns

(::Google::Cloud::Dialogflow::V2::OutputAudio) — The audio data bytes encoded as specified in the request. This field is set if:
- reply_audio_config was specified in the request, or
- The automated agent responded with audio to play to the user. In such case, reply_audio.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.

#reply_audio=

def reply_audio=(value) -> ::Google::Cloud::Dialogflow::V2::OutputAudio

Parameter

value (::Google::Cloud::Dialogflow::V2::OutputAudio) — The audio data bytes encoded as specified in the request. This field is set if:
- reply_audio_config was specified in the request, or
- The automated agent responded with audio to play to the user. In such case, reply_audio.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.

Returns

(::Google::Cloud::Dialogflow::V2::OutputAudio) — The audio data bytes encoded as specified in the request. This field is set if:
- reply_audio_config was specified in the request, or
- The automated agent responded with audio to play to the user. In such case, reply_audio.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.

#reply_text

def reply_text() -> ::String

Returns

(::String) — The output text content. This field is set if the automated agent responded with text to show to the user.

#reply_text=

def reply_text=(value) -> ::String

Parameter

value (::String) — The output text content. This field is set if the automated agent responded with text to show to the user.

Returns

(::String) — The output text content. This field is set if the automated agent responded with text to show to the user.