Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::DetectIntentRequest (v0.27.0)

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

The request to detect user's intent.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#input_audio

def input_audio() -> ::String

Returns

(::String) — The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

#input_audio=

def input_audio=(value) -> ::String

Parameter

value (::String) — The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

Returns

(::String) — The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

#output_audio_config

def output_audio_config() -> ::Google::Cloud::Dialogflow::V2::OutputAudioConfig

Returns

(::Google::Cloud::Dialogflow::V2::OutputAudioConfig) — Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

#output_audio_config=

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

Parameter

value (::Google::Cloud::Dialogflow::V2::OutputAudioConfig) — Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

Returns

(::Google::Cloud::Dialogflow::V2::OutputAudioConfig) — Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

#output_audio_config_mask

def output_audio_config_mask() -> ::Google::Protobuf::FieldMask

Returns

(::Google::Protobuf::FieldMask) — Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

#output_audio_config_mask=

def output_audio_config_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::Google::Protobuf::FieldMask) — Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

Returns

(::Google::Protobuf::FieldMask) — Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

#query_input

def query_input() -> ::Google::Cloud::Dialogflow::V2::QueryInput

Returns

(::Google::Cloud::Dialogflow::V2::QueryInput) —
Required. The input specification. It can be set to:
1. an audio config which instructs the speech recognizer how to process the speech audio,
2. a conversational query in the form of text, or
3. an event that specifies which intent to trigger.

#query_input=

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

Parameter

value (::Google::Cloud::Dialogflow::V2::QueryInput) —
Required. The input specification. It can be set to:
1. an audio config which instructs the speech recognizer how to process the speech audio,
2. a conversational query in the form of text, or
3. an event that specifies which intent to trigger.

Returns

(::Google::Cloud::Dialogflow::V2::QueryInput) —
Required. The input specification. It can be set to:
1. an audio config which instructs the speech recognizer how to process the speech audio,
2. a conversational query in the form of text, or
3. an event that specifies which intent to trigger.

#query_params

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

Returns

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

#query_params=

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

Parameter

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

Returns

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

#session

def session() -> ::String

Returns

(::String) — Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

For more information, see the API interactions guide.

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

#session=

def session=(value) -> ::String

Parameter

value (::String) — Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

For more information, see the API interactions guide.

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

Returns

(::String) — Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

For more information, see the API interactions guide.

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