Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest (v0.9.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest.

The top-level message sent by the client to the Sessions.StreamingDetectIntent method.

Multiple request messages should be sent in order:

The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config.
If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text.

However, note that:

* Dialogflow will bill you for the audio duration so far.
* Dialogflow discards all Speech recognition results in favor of the
  input text.
* Dialogflow will use the language code from the first message.

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

#enable_partial_response

def enable_partial_response() -> ::Boolean

Returns

(::Boolean) — Enable partial detect intent response. If this flag is not enabled, response stream still contains only one final DetectIntentResponse even if some Fulfillments in the agent have been configured to return partial responses.

#enable_partial_response=

def enable_partial_response=(value) -> ::Boolean

Parameter

value (::Boolean) — Enable partial detect intent response. If this flag is not enabled, response stream still contains only one final DetectIntentResponse even if some Fulfillments in the agent have been configured to return partial responses.

Returns

(::Boolean) — Enable partial detect intent response. If this flag is not enabled, response stream still contains only one final DetectIntentResponse even if some Fulfillments in the agent have been configured to return partial responses.

#output_audio_config

def output_audio_config() -> ::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig

Returns

(::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig) — Instructs the speech synthesizer how to generate the output audio.

#output_audio_config=

def output_audio_config=(value) -> ::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig) — Instructs the speech synthesizer how to generate the output audio.

Returns

(::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig) — Instructs the speech synthesizer how to generate the output audio.

#query_input

def query_input() -> ::Google::Cloud::Dialogflow::CX::V3::QueryInput

Returns

(::Google::Cloud::Dialogflow::CX::V3::QueryInput) — Required. The input specification.

#query_input=

def query_input=(value) -> ::Google::Cloud::Dialogflow::CX::V3::QueryInput

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::QueryInput) — Required. The input specification.

Returns

(::Google::Cloud::Dialogflow::CX::V3::QueryInput) — Required. The input specification.

#query_params

def query_params() -> ::Google::Cloud::Dialogflow::CX::V3::QueryParameters

Returns

(::Google::Cloud::Dialogflow::CX::V3::QueryParameters) — The parameters of this query.

#query_params=

def query_params=(value) -> ::Google::Cloud::Dialogflow::CX::V3::QueryParameters

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::QueryParameters) — The parameters of this query.

Returns

(::Google::Cloud::Dialogflow::CX::V3::QueryParameters) — The parameters of this query.

#session

def session() -> ::String

Returns

(::String) — The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. Note: session must be set in the first request.

For more information, see the sessions guide.

Note: Always use agent versions for production traffic. See Versions and environments.

#session=

def session=(value) -> ::String

Parameter

value (::String) — The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. Note: session must be set in the first request.

For more information, see the sessions guide.

Note: Always use agent versions for production traffic. See Versions and environments.

Returns

(::String) — The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. Note: session must be set in the first request.

For more information, see the sessions guide.

Note: Always use agent versions for production traffic. See Versions and environments.