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

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

The top-level message returned from the StreamingAnalyzeContent method.

Multiple response messages can be returned in order:

If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.
In virtual agent stage: if enable_partial_automated_agent_reply is true, the following N (currently 1 <= N <= 4) messages contain automated_agent_reply and optionally reply_audio returned by the virtual agent. The first (N-1) automated_agent_replys will have automated_agent_reply_type set to PARTIAL. The last automated_agent_reply has automated_agent_reply_type set to FINAL. If enable_partial_automated_agent_reply is not enabled, response stream only contains the final reply.

In human assist stage: the following N (N >= 1) messages contain human_agent_suggestion_results, end_user_suggestion_results or message.

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) — 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) — 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) — Note that in [AutomatedAgentReply.DetectIntentResponse][], [Sessions.DetectIntentResponse.output_audio][] and [Sessions.DetectIntentResponse.output_audio_config][] are always empty, use reply_audio instead.

#debugging_info

def debugging_info() -> ::Google::Cloud::Dialogflow::V2::CloudConversationDebuggingInfo

Returns

(::Google::Cloud::Dialogflow::V2::CloudConversationDebuggingInfo) — Debugging info that would get populated when StreamingAnalyzeContentRequest.enable_debugging_info is set to true.

#debugging_info=

def debugging_info=(value) -> ::Google::Cloud::Dialogflow::V2::CloudConversationDebuggingInfo

Parameter

value (::Google::Cloud::Dialogflow::V2::CloudConversationDebuggingInfo) — Debugging info that would get populated when StreamingAnalyzeContentRequest.enable_debugging_info is set to true.

Returns

(::Google::Cloud::Dialogflow::V2::CloudConversationDebuggingInfo) — Debugging info that would get populated when StreamingAnalyzeContentRequest.enable_debugging_info is set to true.

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

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

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.

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

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

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.

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

#recognition_result

def recognition_result() -> ::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult

Returns

(::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult) — The result of speech recognition.

#recognition_result=

def recognition_result=(value) -> ::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult

Parameter

value (::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult) — The result of speech recognition.

Returns

(::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult) — The result of speech recognition.

#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:
- The reply_audio_config field is specified in the request.
- The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field 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:
- The reply_audio_config field is specified in the request.
- The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field 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:
- The reply_audio_config field is specified in the request.
- The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field 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 an automated agent responded with a text for the user.

#reply_text=

def reply_text=(value) -> ::String

Parameter

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

Returns

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