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 |
QueryParameters
The parameters of this query. |
↳ query_input |
QueryInput
Required. The input specification. |
↳ output_audio_config |
OutputAudioConfig
Instructs the speech synthesizer how to generate the output audio. |
↳ response_view |
int
Optional. Specifies which fields in the QueryResult to return. If not set, the default is DETECT_INTENT_RESPONSE_VIEW_FULL. |
getSession
Required. The name of the session this query is sent to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<Session
ID> or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>.
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<Session
ID> or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>.
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 |
QueryParameters|null |
|
hasQueryParams
clearQueryParams
setQueryParams
The parameters of this query.
| Parameter | |
|---|---|
| Name | Description |
var |
QueryParameters
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryInput
Required. The input specification.
| Returns | |
|---|---|
| Type | Description |
QueryInput|null |
|
hasQueryInput
clearQueryInput
setQueryInput
Required. The input specification.
| Parameter | |
|---|---|
| Name | Description |
var |
QueryInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputAudioConfig
Instructs the speech synthesizer how to generate the output audio.
| Returns | |
|---|---|
| Type | Description |
OutputAudioConfig|null |
|
hasOutputAudioConfig
clearOutputAudioConfig
setOutputAudioConfig
Instructs the speech synthesizer how to generate the output audio.
| Parameter | |
|---|---|
| Name | Description |
var |
OutputAudioConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResponseView
Optional. Specifies which fields in the QueryResult to return. If not set, the default is DETECT_INTENT_RESPONSE_VIEW_FULL.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DetectIntentResponseView. |
setResponseView
Optional. Specifies which fields in the QueryResult to return. If not set, the default is DETECT_INTENT_RESPONSE_VIEW_FULL.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type DetectIntentResponseView. |
| Returns | |
|---|---|
| Type | Description |
$this |
|