Class: Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest

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

Overview

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

Multiple request messages should be sent in order:

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#enable_debugging_info ⇒ ::Boolean

Returns If true, StreamingDetectIntentResponse.debugging_info will get populated.

Returns:

  • (::Boolean) —

    If true, StreamingDetectIntentResponse.debugging_info will get populated.



246
247
248
249
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 246

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

#enable_partial_response ⇒ ::Boolean

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



246
247
248
249
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 246

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

#output_audio_config ⇒ ::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig

Returns Instructs the speech synthesizer how to generate the output audio.

Returns:



246
247
248
249
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 246

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

#query_input ⇒ ::Google::Cloud::Dialogflow::CX::V3::QueryInput

Returns Required. The input specification.

Returns:



246
247
248
249
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 246

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

#query_params ⇒ ::Google::Cloud::Dialogflow::CX::V3::QueryParameters

Returns The parameters of this query.

Returns:



246
247
248
249
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 246

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

#session ⇒ ::String

Returns The name of the session this query is sent to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. 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.



246
247
248
249
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 246

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