Class: Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest
- 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:
The first message must contain
session
,query_input
plus optionallyquery_params
and/orsingle_utterance
. The message must not containinput_audio
.If
query_input
was set to a streaming input audio config, all subsequent messages must contain onlyinput_audio
. Otherwise, finish the request stream.
Instance Attribute Summary collapse
-
#input_audio ⇒ String
Optional.
-
#query_input ⇒ Google::Cloud::Dialogflow::V2::QueryInput
Required.
-
#query_params ⇒ Google::Cloud::Dialogflow::V2::QueryParameters
Optional.
-
#session ⇒ String
Required.
-
#single_utterance ⇒ true, false
Optional.
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.
231 |
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 231 class StreamingDetectIntentRequest; end |
#query_input ⇒ Google::Cloud::Dialogflow::V2::QueryInput
Returns Required. The input specification. It can be set to:
an audio config which instructs the speech recognizer how to process the speech audio,
a conversational query in the form of text, or
an event that specifies which intent to trigger.
231 |
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 231 class StreamingDetectIntentRequest; end |
#query_params ⇒ Google::Cloud::Dialogflow::V2::QueryParameters
Returns Optional. The parameters of this query.
231 |
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 231 class StreamingDetectIntentRequest; end |
#session ⇒ String
Returns Required. The name of the session the query is sent to.
Format of the session name:
projects/<Project ID>/agent/sessions/<Session ID>
. It’s up to the API
caller to choose an appropriate
231 |
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 231 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.
231 |
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb', line 231 class StreamingDetectIntentRequest; end |