Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest (v1.12.0)

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

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#assist_query_params

def assist_query_params() -> ::Google::Cloud::Dialogflow::V2::AssistQueryParameters
Returns

#assist_query_params=

def assist_query_params=(value) -> ::Google::Cloud::Dialogflow::V2::AssistQueryParameters
Parameter
Returns

#audio_config

def audio_config() -> ::Google::Cloud::Dialogflow::V2::InputAudioConfig
Returns
  • (::Google::Cloud::Dialogflow::V2::InputAudioConfig) — Instructs the speech recognizer how to process the speech audio.

    Note: The following fields are mutually exclusive: audio_config, text_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#audio_config=

def audio_config=(value) -> ::Google::Cloud::Dialogflow::V2::InputAudioConfig
Parameter
  • value (::Google::Cloud::Dialogflow::V2::InputAudioConfig) — Instructs the speech recognizer how to process the speech audio.

    Note: The following fields are mutually exclusive: audio_config, text_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::InputAudioConfig) — Instructs the speech recognizer how to process the speech audio.

    Note: The following fields are mutually exclusive: audio_config, text_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cx_parameters

def cx_parameters() -> ::Google::Protobuf::Struct
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.

#cx_parameters=

def cx_parameters=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::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.

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.

#enable_debugging_info

def enable_debugging_info() -> ::Boolean
Returns
  • (::Boolean) — If true, StreamingAnalyzeContentResponse.debugging_info will get populated.

#enable_debugging_info=

def enable_debugging_info=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, StreamingAnalyzeContentResponse.debugging_info will get populated.
Returns
  • (::Boolean) — If true, StreamingAnalyzeContentResponse.debugging_info will get populated.

#enable_extended_streaming

def enable_extended_streaming() -> ::Boolean
Returns
  • (::Boolean) — 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

#enable_extended_streaming=

def enable_extended_streaming=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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

#enable_partial_automated_agent_reply

def enable_partial_automated_agent_reply() -> ::Boolean
Returns
  • (::Boolean) — Optional. Enable partial responses from Dialogflow CX agent. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow CX agent have been configured to return partial responses.

#enable_partial_automated_agent_reply=

def enable_partial_automated_agent_reply=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Enable partial responses from Dialogflow CX agent. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow CX agent have been configured to return partial responses.
Returns
  • (::Boolean) — Optional. Enable partial responses from Dialogflow CX agent. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow CX agent have been configured to return partial responses.

#input_audio

def input_audio() -> ::String
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.

    Note: The following fields are mutually exclusive: input_audio, input_text, input_dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#input_audio=

def input_audio=(value) -> ::String
Parameter
  • value (::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.

    Note: The following fields are mutually exclusive: input_audio, input_text, input_dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

    Note: The following fields are mutually exclusive: input_audio, input_text, input_dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#input_dtmf

def input_dtmf() -> ::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents
Returns
  • (::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents) — 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.

    Note: The following fields are mutually exclusive: input_dtmf, input_audio, input_text. If a field in that set is populated, all other fields in the set will automatically be cleared.

#input_dtmf=

def input_dtmf=(value) -> ::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents
Parameter
  • value (::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents) — 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.

    Note: The following fields are mutually exclusive: input_dtmf, input_audio, input_text. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents) — 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.

    Note: The following fields are mutually exclusive: input_dtmf, input_audio, input_text. If a field in that set is populated, all other fields in the set will automatically be cleared.

#input_text

def input_text() -> ::String
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.

    Note: The following fields are mutually exclusive: input_text, input_audio, input_dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#input_text=

def input_text=(value) -> ::String
Parameter
  • value (::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.

    Note: The following fields are mutually exclusive: input_text, input_audio, input_dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

    Note: The following fields are mutually exclusive: input_text, input_audio, input_dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#participant

def participant() -> ::String
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>.

#participant=

def participant=(value) -> ::String
Parameter
  • value (::String) — 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>.

#query_params

def query_params() -> ::Google::Cloud::Dialogflow::V2::QueryParameters
Returns

#query_params=

def query_params=(value) -> ::Google::Cloud::Dialogflow::V2::QueryParameters
Parameter
Returns

#reply_audio_config

def reply_audio_config() -> ::Google::Cloud::Dialogflow::V2::OutputAudioConfig
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.

#reply_audio_config=

def reply_audio_config=(value) -> ::Google::Cloud::Dialogflow::V2::OutputAudioConfig
Parameter
  • value (::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.
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.

#text_config

def text_config() -> ::Google::Cloud::Dialogflow::V2::InputTextConfig
Returns
  • (::Google::Cloud::Dialogflow::V2::InputTextConfig) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text_config, audio_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_config=

def text_config=(value) -> ::Google::Cloud::Dialogflow::V2::InputTextConfig
Parameter
  • value (::Google::Cloud::Dialogflow::V2::InputTextConfig) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text_config, audio_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::V2::InputTextConfig) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text_config, audio_config. If a field in that set is populated, all other fields in the set will automatically be cleared.