Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class StreamingDetectIntentRequest.
The top-level message sent by the client to the Sessions.StreamingDetectIntent method.
Multiple request messages should be sent in order:
- 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.
- 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.
Generated from protobuf message google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session |
string
The name of the session this query is sent to. Format: |
↳ query_params |
Google\Cloud\Dialogflow\Cx\V3\QueryParameters
The parameters of this query. |
↳ query_input |
Google\Cloud\Dialogflow\Cx\V3\QueryInput
Required. The input specification. |
↳ output_audio_config |
Google\Cloud\Dialogflow\Cx\V3\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 |
↳ enable_debugging_info |
bool
If true, |
getSession
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.
Returns | |
---|---|
Type | Description |
string |
setSession
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getQueryParams
The parameters of this query.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dialogflow\Cx\V3\QueryParameters|null |
hasQueryParams
clearQueryParams
setQueryParams
The parameters of this query.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\QueryParameters
|
Returns | |
---|---|
Type | Description |
$this |
getQueryInput
Required. The input specification.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dialogflow\Cx\V3\QueryInput|null |
hasQueryInput
clearQueryInput
setQueryInput
Required. The input specification.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\QueryInput
|
Returns | |
---|---|
Type | Description |
$this |
getOutputAudioConfig
Instructs the speech synthesizer how to generate the output audio.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dialogflow\Cx\V3\OutputAudioConfig|null |
hasOutputAudioConfig
clearOutputAudioConfig
setOutputAudioConfig
Instructs the speech synthesizer how to generate the output audio.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\OutputAudioConfig
|
Returns | |
---|---|
Type | Description |
$this |
getEnablePartialResponse
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.
Returns | |
---|---|
Type | Description |
bool |
setEnablePartialResponse
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getEnableDebuggingInfo
If true, StreamingDetectIntentResponse.debugging_info
will get populated.
Returns | |
---|---|
Type | Description |
bool |
setEnableDebuggingInfo
If true, StreamingDetectIntentResponse.debugging_info
will get populated.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |