public sealed class StreamingDetectIntentRequest : IMessage<StreamingDetectIntentRequest>, IEquatable<StreamingDetectIntentRequest>, IDeepCloneable<StreamingDetectIntentRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Dialogflow v3 API class StreamingDetectIntentRequest.
The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method.
Multiple request messages should be sent in order:
The first message must contain [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config].
If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.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.cx.v3.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.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.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 |
EnablePartialResponse
public bool EnablePartialResponse { get; set; }
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.
Property Value | |
---|---|
Type | Description |
bool |
OutputAudioConfig
public OutputAudioConfig OutputAudioConfig { get; set; }
Instructs the speech synthesizer how to generate the output audio.
Property Value | |
---|---|
Type | Description |
OutputAudioConfig |
QueryInput
public QueryInput QueryInput { get; set; }
Required. The input specification.
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; }
The name of the session this query is sent to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/sessions/<Session ID>
or projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
.
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.
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 |