Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse (v0.22.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:

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

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

#automated_agent_reply=

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

#dtmf_parameters

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

#dtmf_parameters=

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

#end_user_suggestion_results

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

#end_user_suggestion_results=

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

#human_agent_suggestion_results

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

#human_agent_suggestion_results=

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

#message

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

#message=

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

#recognition_result

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

#recognition_result=

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

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