Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class DetectIntentRequest.
The request to detect user's intent.
Generated from protobuf message google.cloud.dialogflow.cx.v3.DetectIntentRequest
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session |
string
Required. 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. |
getSession
Required. 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.
For more information, see the sessions
guide.
Note: Always use agent versions for production traffic.
See Versions and
environments.
Returns | |
---|---|
Type | Description |
string |
setSession
Required. 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.
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 |