Class StreamingDetectIntentResponse (2.0.0)

Version 2.0.0

• 2.38.0 (latest)
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.2
• 2.29.0
• 2.28.3
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.8.0
• 0.7.2

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

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

1. If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.

2. The next message contains response_id, query_result, alternative_query_results and optionally webhook_status if a WebHook was called.

3. If output_audio_config was specified in the request or agent-level speech synthesizer is configured, all subsequent messages contain output_audio and output_audio_config.

Attributes
Name	Description
response_id	str The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
recognition_result	.gcd_session.StreamingRecognitionResult The result of speech recognition.
query_result	.gcd_session.QueryResult The selected results of the conversational query or event processing. See alternative_query_results for additional potential results.
alternative_query_results	Sequence[.gcd_session.QueryResult] If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.
webhook_status	.status.Status Specifies the status of the webhook request.
output_audio	bytes The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.fulfillment_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.
output_audio_config	.gcd_audio_config.OutputAudioConfig The config used by the speech synthesizer to generate the output audio.