Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class QueryParameters.
Represents the parameters of a conversational query.
Generated from protobuf message google.cloud.dialogflow.cx.v3.QueryParameters
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ time_zone |
string
The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used. |
↳ geo_location |
Google\Type\LatLng
The geo location of this conversational query. |
↳ session_entity_types |
array<Google\Cloud\Dialogflow\Cx\V3\SessionEntityType>
Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. |
↳ payload |
Google\Protobuf\Struct
This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: |
↳ parameters |
Google\Protobuf\Struct
Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. |
↳ current_page |
string
The unique identifier of the page to override the current page in the session. Format: |
↳ disable_webhook |
bool
Whether to disable webhook calls for this request. |
↳ analyze_query_text_sentiment |
bool
Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. |
↳ webhook_headers |
array|Google\Protobuf\Internal\MapField
This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc. |
↳ flow_versions |
array
A list of flow versions to override for the request. Format: |
↳ channel |
string
The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. |
↳ session_ttl |
Google\Protobuf\Duration
Optional. Sets Dialogflow session life time. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day. |
↳ end_user_metadata |
Google\Protobuf\Struct
Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: |
↳ search_config |
Google\Cloud\Dialogflow\Cx\V3\SearchConfig
Optional. Search configuration for UCS search queries. |
getTimeZone
The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.
| Returns | |
|---|---|
| Type | Description |
string | |
setTimeZone
The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGeoLocation
The geo location of this conversational query.
| Returns | |
|---|---|
| Type | Description |
Google\Type\LatLng|null | |
hasGeoLocation
clearGeoLocation
setGeoLocation
The geo location of this conversational query.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\LatLng
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSessionEntityTypes
Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSessionEntityTypes
Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\Cx\V3\SessionEntityType>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPayload
This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.
Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form:
{
"telephony": {
"caller_id": "+18558363987"
}
}
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasPayload
clearPayload
setPayload
This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.
Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form:
{
"telephony": {
"caller_id": "+18558363987"
}
}
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameters
Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.
You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
- MapKey type: string
- MapKey value: parameter name
- MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
- MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasParameters
clearParameters
setParameters
Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.
You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
- MapKey type: string
- MapKey value: parameter name
- MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
- MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCurrentPage
The unique identifier of the page to override the current page in the session.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>.
If current_page is specified, the previous state of the session will be
ignored by Dialogflow, including the previous
page and the previous session
parameters.
In most cases,
current_page
and parameters
should be configured together to direct a session to a specific state.
| Returns | |
|---|---|
| Type | Description |
string | |
setCurrentPage
The unique identifier of the page to override the current page in the session.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>.
If current_page is specified, the previous state of the session will be
ignored by Dialogflow, including the previous
page and the previous session
parameters.
In most cases,
current_page
and parameters
should be configured together to direct a session to a specific state.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisableWebhook
Whether to disable webhook calls for this request.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDisableWebhook
Whether to disable webhook calls for this request.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnalyzeQueryTextSentiment
Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAnalyzeQueryTextSentiment
Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWebhookHeaders
This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive.
Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setWebhookHeaders
This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive.
Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFlowVersions
A list of flow versions to override for the request.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/versions/<Version ID>.
If version 1 of flow X is included in this list, the traffic of
flow X will go through version 1 regardless of the version configuration in
the environment. Each flow can have at most one version specified in this
list.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFlowVersions
A list of flow versions to override for the request.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/versions/<Version ID>.
If version 1 of flow X is included in this list, the traffic of
flow X will go through version 1 regardless of the version configuration in
the environment. Each flow can have at most one version specified in this
list.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getChannel
The channel which this query is for.
If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setChannel
The channel which this query is for.
If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSessionTtl
Optional. Sets Dialogflow session life time.
By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasSessionTtl
clearSessionTtl
setSessionTtl
Optional. Sets Dialogflow session life time.
By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndUserMetadata
Optional. Information about the end-user to improve the relevance and accuracy of generative answers.
This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example:
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasEndUserMetadata
clearEndUserMetadata
setEndUserMetadata
Optional. Information about the end-user to improve the relevance and accuracy of generative answers.
This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example:
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSearchConfig
Optional. Search configuration for UCS search queries.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\Cx\V3\SearchConfig|null | |
hasSearchConfig
clearSearchConfig
setSearchConfig
Optional. Search configuration for UCS search queries.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\SearchConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |