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 optionally
query_params.
If the client wants to receive an audio response, it should also
contain
output_audio_config.
The message must not contain
input_audio.
If
query_input
was set to
query_input.audio_config,
all subsequent messages must contain
input_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.
Attributes
Name
Description
session
str
Required. The name of the session the query is sent to.
Format of the session name:
projects/, or
projects/.
If Environment ID is not specified, we assume default
'draft' environment. 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
google.cloud.dialogflow_v2.types.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.
single_utterance
bool
Please use
InputAudioConfig.single_utterance
instead. 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.
output_audio_config
google.cloud.dialogflow_v2.types.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
google.protobuf.field_mask_pb2.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.
input_audio
bytes
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.
enable_debugging_info
bool
if true, StreamingDetectIntentResponse.debugging_info
will get populated.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class StreamingDetectIntentRequest (2.41.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.41.2 (latest)](/python/docs/reference/dialogflow/latest/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.41.1](/python/docs/reference/dialogflow/2.41.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.40.0](/python/docs/reference/dialogflow/2.40.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.39.1](/python/docs/reference/dialogflow/2.39.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.38.0](/python/docs/reference/dialogflow/2.38.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.37.0](/python/docs/reference/dialogflow/2.37.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.36.0](/python/docs/reference/dialogflow/2.36.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.35.0](/python/docs/reference/dialogflow/2.35.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.34.0](/python/docs/reference/dialogflow/2.34.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.33.0](/python/docs/reference/dialogflow/2.33.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.32.0](/python/docs/reference/dialogflow/2.32.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.30.2](/python/docs/reference/dialogflow/2.30.2/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.29.0](/python/docs/reference/dialogflow/2.29.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.28.3](/python/docs/reference/dialogflow/2.28.3/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.27.0](/python/docs/reference/dialogflow/2.27.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.26.0](/python/docs/reference/dialogflow/2.26.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.25.0](/python/docs/reference/dialogflow/2.25.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.24.1](/python/docs/reference/dialogflow/2.24.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.23.3](/python/docs/reference/dialogflow/2.23.3/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.22.0](/python/docs/reference/dialogflow/2.22.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.21.0](/python/docs/reference/dialogflow/2.21.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.20.0](/python/docs/reference/dialogflow/2.20.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.19.1](/python/docs/reference/dialogflow/2.19.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.18.0](/python/docs/reference/dialogflow/2.18.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.17.0](/python/docs/reference/dialogflow/2.17.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.16.1](/python/docs/reference/dialogflow/2.16.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.15.2](/python/docs/reference/dialogflow/2.15.2/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.14.1](/python/docs/reference/dialogflow/2.14.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.13.0](/python/docs/reference/dialogflow/2.13.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.12.0](/python/docs/reference/dialogflow/2.12.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.11.0](/python/docs/reference/dialogflow/2.11.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.10.0](/python/docs/reference/dialogflow/2.10.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.9.1](/python/docs/reference/dialogflow/2.9.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.8.1](/python/docs/reference/dialogflow/2.8.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.7.1](/python/docs/reference/dialogflow/2.7.1/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.6.0](/python/docs/reference/dialogflow/2.6.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.5.0](/python/docs/reference/dialogflow/2.5.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.4.0](/python/docs/reference/dialogflow/2.4.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.3.0](/python/docs/reference/dialogflow/2.3.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.2.0](/python/docs/reference/dialogflow/2.2.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.1.2](/python/docs/reference/dialogflow/2.1.2/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [2.0.0](/python/docs/reference/dialogflow/2.0.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [1.1.3](/python/docs/reference/dialogflow/1.1.3/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [1.0.0](/python/docs/reference/dialogflow/1.0.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [0.8.0](/python/docs/reference/dialogflow/0.8.0/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest)\n- [0.7.2](/python/docs/reference/dialogflow/0.7.2/google.cloud.dialogflow_v2.types.StreamingDetectIntentRequest) \n\n StreamingDetectIntentRequest(\n mapping=None, *, ignore_unknown_fields=False, **kwargs\n )\n\nThe top-level message sent by the client to the\n\\[StreamingDetectIntent\\]\\[\\] method.\n\nMultiple request messages should be sent in order:\n\n1. The first message must contain\n session,\n query_input\n plus optionally\n query_params.\n If the client wants to receive an audio response, it should also\n contain\n output_audio_config.\n The message must not contain\n input_audio.\n\n2. If\n query_input\n was set to\n query_input.audio_config,\n all subsequent messages must contain\n input_audio\n to continue with Speech recognition. If you decide to rather\n detect an intent from text input after you already started Speech\n recognition, please send a message with\n query_input.text.\n\n However, note that:\n - Dialogflow will bill you for the audio duration so far.\n - Dialogflow discards all Speech recognition results in favor of the input text.\n - Dialogflow will use the language code from the first message.\n\nAfter you sent all input, you must half-close or abort the request\nstream."]]