Class: Google::Cloud::Dialogflow::V2::DetectIntentRequest

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

Overview

The request to detect user's intent.

Instance Attribute Summary collapse

Instance Attribute Details

#input_audio ⇒ ::String

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



77
78
79
80
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 77

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

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

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



77
78
79
80
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 77

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

#output_audio_config_mask ⇒ ::Google::Protobuf::FieldMask

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



77
78
79
80
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 77

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

#query_input ⇒ ::Google::Cloud::Dialogflow::V2::QueryInput

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



77
78
79
80
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 77

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

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

Returns The parameters of this query.

Returns:



77
78
79
80
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 77

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

#session ⇒ ::String

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



77
78
79
80
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 77

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