Class: Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb

Overview

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

Multiple request messages should be sent in order:

  1. The first message must contain +session+, +query_input+ plus optionally +query_params+ and/or +single_utterance+. The message must not contain +input_audio+.

  2. If +query_input+ was set to a streaming input audio config, all subsequent messages must contain only +input_audio+. Otherwise, finish the request stream.

Instance Attribute Summary collapse

Instance Attribute Details

#input_audio ⇒ String

Returns Optional. The input audio content to be recognized. Must be sent if +query_input+ was set to a streaming input audio config. The complete audio over all streaming messages must not exceed 1 minute.

Returns:

  • (String) —

    Optional. The input audio content to be recognized. Must be sent if +query_input+ was set to a streaming input audio config. The complete audio over all streaming messages must not exceed 1 minute.



230
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 230

class StreamingDetectIntentRequest; 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.



230
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 230

class StreamingDetectIntentRequest; end

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

Returns Optional. The parameters of this query.

Returns:



230
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 230

class StreamingDetectIntentRequest; end

#session ⇒ String

Returns Required. The name of the session the query is sent to. Format of the session name: +projects//agent/sessions/+. It’s up to the API caller to choose an appropriate . It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 characters.

Returns:

  • (String) —

    Required. The name of the session the query is sent to. Format of the session name: +projects//agent/sessions/+. It’s up to the API caller to choose an appropriate . It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 characters.



230
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 230

class StreamingDetectIntentRequest; end

#single_utterance ⇒ true, false

Returns Optional. If +false+ (default), recognition does not cease until the client closes the stream. If +true+, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. This setting is ignored when +query_input+ is a piece of text or an event.

Returns:

  • (true, false) —

    Optional. If +false+ (default), recognition does not cease until the client closes the stream. If +true+, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. This setting is ignored when +query_input+ is a piece of text or an event.



230
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 230

class StreamingDetectIntentRequest; end