Class: Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/participant.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#automated_agent_reply ⇒ ::Google::Cloud::Dialogflow::V2::AutomatedAgentReply

Returns 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 reply_audio instead.

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#debugging_info ⇒ ::Google::Cloud::Dialogflow::V2::CloudConversationDebuggingInfo

Returns Debugging info that would get populated when StreamingAnalyzeContentRequest.enable_debugging_info is set to true.

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dtmf_parameters ⇒ ::Google::Cloud::Dialogflow::V2::DtmfParameters

Returns Indicates the parameters of DTMF.

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#end_user_suggestion_results ⇒ ::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>

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

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#human_agent_suggestion_results ⇒ ::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>

Returns The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#message ⇒ ::Google::Cloud::Dialogflow::V2::Message

Returns Message analyzed by CCAI.

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#recognition_result ⇒ ::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult

Returns The result of speech recognition.

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#reply_audio ⇒ ::Google::Cloud::Dialogflow::V2::OutputAudio

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



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#reply_text ⇒ ::String

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



547
548
549
550
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 547

class StreamingAnalyzeContentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end