Class StreamingDetectIntentRequest (1.37.0)

StreamingDetectIntentRequest(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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.

Attributes

Name Description
session str
The name of the session this query is sent to. Format: projects/ or projects/. 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
query_params google.cloud.dialogflowcx_v3.types.QueryParameters
The parameters of this query.
query_input google.cloud.dialogflowcx_v3.types.QueryInput
Required. The input specification.
output_audio_config google.cloud.dialogflowcx_v3.types.OutputAudioConfig
Instructs the speech synthesizer how to generate the output audio.
enable_partial_response bool
Enable partial detect intent response. If this flag is not enabled, response stream still contains only one final DetectIntentResponse even if some Fulfillment\ s in the agent have been configured to return partial responses.
enable_debugging_info bool
If true, StreamingDetectIntentResponse.debugging_info will get populated.