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:
If the
StreamingDetectIntentRequest.input_audio
field was set, therecognition_result
field is populated for one or more messages. See the StreamingRecognitionResult message for details about the result message sequence.The next message contains
response_id
,query_result
,alternative_query_results
and optionallywebhook_status
if a WebHook was called.If
output_audio_config
was specified in the request or agent-level speech synthesizer is configured, all subsequent messages containoutput_audio
andoutput_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 |
google.cloud.dialogflow_v2beta1.types.StreamingRecognitionResult
The result of speech recognition. |
query_result |
google.cloud.dialogflow_v2beta1.types.QueryResult
The selected results of the conversational query or event processing. See ``alternative_query_results`` for additional potential results. |
alternative_query_results |
Sequence[google.cloud.dialogflow_v2beta1.types.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 |
google.rpc.status_pb2.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 |
google.cloud.dialogflow_v2beta1.types.OutputAudioConfig
The config used by the speech synthesizer to generate the output audio. |