public sealed class StreamingDetectIntentRequest : IMessage<StreamingDetectIntentRequest>, IEquatable<StreamingDetectIntentRequest>, IDeepCloneable<StreamingDetectIntentRequest>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class StreamingDetectIntentRequest.
The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent] method.
Multiple request messages should be sent in order:
- The first message must contain [session][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config]. The message must not contain [input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.input_audio].
If [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] was set to [query_input.audio_config][google.cloud.dialogflow.v2beta1.InputAudioConfig], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.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][google.cloud.dialogflow.v2beta1.QueryInput.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.
Implements
IMessageStreamingDetectIntentRequest, IEquatableStreamingDetectIntentRequest, IDeepCloneableStreamingDetectIntentRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Dialogflow.V2Beta1Assembly
Google.Cloud.Dialogflow.V2Beta1.dll
Constructors
StreamingDetectIntentRequest()
public StreamingDetectIntentRequest()StreamingDetectIntentRequest(StreamingDetectIntentRequest)
public StreamingDetectIntentRequest(StreamingDetectIntentRequest other)| Parameter | |
|---|---|
| Name | Description |
other | StreamingDetectIntentRequest |
Properties
EnableDebuggingInfo
public bool EnableDebuggingInfo { get; set; }If true, StreamingDetectIntentResponse.debugging_info will get populated.
| Property Value | |
|---|---|
| Type | Description |
bool | |
InputAudio
public ByteString InputAudio { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ByteString | |
OutputAudioConfig
public OutputAudioConfig OutputAudioConfig { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
OutputAudioConfig | |
OutputAudioConfigMask
public FieldMask OutputAudioConfigMask { get; set; }Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.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][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] replaces the agent-level config in its entirety.
| Property Value | |
|---|---|
| Type | Description |
FieldMask | |
QueryInput
public QueryInput QueryInput { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
QueryInput | |
QueryParams
public QueryParameters QueryParams { get; set; }The parameters of this query.
| Property Value | |
|---|---|
| Type | Description |
QueryParameters | |
Session
public string Session { get; set; }Required. The name of the session the query is sent to. Supported formats:
- `projects/<Project ID>/agent/sessions/<Session ID>,
projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
If Location ID is not specified we assume default 'us' location. 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.
Note: Always use agent versions for production traffic. See Versions and environments.
| Property Value | |
|---|---|
| Type | Description |
string | |
SessionAsSessionName
public SessionName SessionAsSessionName { get; set; }SessionName-typed view over the Session resource name property.
| Property Value | |
|---|---|
| Type | Description |
SessionName | |
SingleUtterance
[Obsolete]
public bool SingleUtterance { get; set; }DEPRECATED. Please use
[InputAudioConfig.single_utterance][google.cloud.dialogflow.v2beta1.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.
| Property Value | |
|---|---|
| Type | Description |
bool | |