Class: Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest

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 sent by the client to the Participants.StreamingAnalyzeContent method.

Multiple request messages should be sent in order:

  1. The first message must contain participant, [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] and optionally query_params. If you want to receive an audio response, it should also contain reply_audio_config. The message must not contain [input][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input].

  2. If [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message was set to audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. However, note that:

* Dialogflow will bill you for the audio so far.
* Dialogflow discards all Speech recognition results in favor of the
  text input.
  1. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message was set to StreamingAnalyzeContentRequest.text_config, then the second message must contain only input_text. Moreover, you must not send more than two messages.

After you sent all input, you must half-close or abort the request stream.

Instance Attribute Summary collapse

Instance Attribute Details

#assist_query_params ⇒ ::Google::Cloud::Dialogflow::V2::AssistQueryParameters

Returns Parameters for a human assist query.

Returns:



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#audio_config ⇒ ::Google::Cloud::Dialogflow::V2::InputAudioConfig

Returns Instructs the speech recognizer how to process the speech audio.

Returns:



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#cx_parameters ⇒ ::Google::Protobuf::Struct

Returns Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

Returns:

  • (::Google::Protobuf::Struct) —

    Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

    Note: this field should only be used if you are connecting to a Dialogflow CX agent.



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#enable_debugging_info ⇒ ::Boolean

Returns If true, StreamingAnalyzeContentResponse.debugging_info will get populated.

Returns:

  • (::Boolean) —

    If true, StreamingAnalyzeContentResponse.debugging_info will get populated.



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#enable_extended_streaming ⇒ ::Boolean

Returns Optional. Enable full bidirectional streaming. You can keep streaming the audio until timeout, and there's no need to half close the stream to get the response.

Restrictions:

InvalidArgument Error will be returned if the one of restriction checks failed.

You can find more details in https://cloud.google.com/agent-assist/docs/extended-streaming.

Returns:



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#enable_partial_automated_agent_reply ⇒ ::Boolean

Returns Enable partial virtual agent responses. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow virtual agent have been configured to return partial responses.

Returns:

  • (::Boolean) —

    Enable partial virtual agent responses. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow virtual agent have been configured to return partial responses.



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#input_audio ⇒ ::String

Returns The input audio content to be recognized. Must be sent if audio_config is set in the first message. The complete audio over all streaming messages must not exceed 1 minute.

Returns:

  • (::String) —

    The input audio content to be recognized. Must be sent if audio_config is set in the first message. The complete audio over all streaming messages must not exceed 1 minute.



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#input_dtmf ⇒ ::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents

Returns The DTMF digits used to invoke intent and fill in parameter value.

This input is ignored if the previous response indicated that DTMF input is not accepted.

Returns:



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#input_text ⇒ ::String

Returns The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.

Returns:

  • (::String) —

    The UTF-8 encoded natural language text to be processed. Must be sent if text_config is set in the first message. Text length must not exceed 256 bytes for virtual agent interactions. The input_text field can be only sent once, and would cancel the speech recognition if any ongoing.



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#participant ⇒ ::String

Returns Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns:

  • (::String) —

    Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#query_params ⇒ ::Google::Cloud::Dialogflow::V2::QueryParameters

Returns Parameters for a Dialogflow virtual-agent query.

Returns:



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#reply_audio_config ⇒ ::Google::Cloud::Dialogflow::V2::OutputAudioConfig

Returns Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

Returns:

  • (::Google::Cloud::Dialogflow::V2::OutputAudioConfig) —

    Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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

#text_config ⇒ ::Google::Cloud::Dialogflow::V2::InputTextConfig

Returns The natural language text to be processed.

Returns:



472
473
474
475
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 472

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