Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class QueryParameters.
Represents the parameters of the conversational query.
Generated from protobuf message google.cloud.dialogflow.v2.QueryParameters
Methods
__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 agent settings is used. |
↳ geo_location |
Google\Type\LatLng
The geo location of this conversational query. |
↳ contexts |
array<Google\Cloud\Dialogflow\V2\Context>
The collection of contexts to be activated before this query is executed. |
↳ reset_contexts |
bool
Specifies whether to delete all contexts in the current session before the new ones are activated. |
↳ session_entity_types |
array<Google\Cloud\Dialogflow\V2\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 to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the |
↳ sentiment_analysis_request_config |
Google\Cloud\Dialogflow\V2\SentimentAnalysisRequestConfig
Configures the type of sentiment analysis to perform. 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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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. |
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 agent settings is used.
Generated from protobuf field string time_zone = 1;
| 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 agent settings is used.
Generated from protobuf field string time_zone = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGeoLocation
The geo location of this conversational query.
Generated from protobuf field .google.type.LatLng geo_location = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Type\LatLng|null | |
hasGeoLocation
clearGeoLocation
setGeoLocation
The geo location of this conversational query.
Generated from protobuf field .google.type.LatLng geo_location = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\LatLng
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContexts
The collection of contexts to be activated before this query is executed.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context contexts = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setContexts
The collection of contexts to be activated before this query is executed.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Context contexts = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\V2\Context>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResetContexts
Specifies whether to delete all contexts in the current session before the new ones are activated.
Generated from protobuf field bool reset_contexts = 4;
| Returns | |
|---|---|
| Type | Description |
bool | |
setResetContexts
Specifies whether to delete all contexts in the current session before the new ones are activated.
Generated from protobuf field bool reset_contexts = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| 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.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 5;
| 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.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\V2\SessionEntityType>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPayload
This field can be used to pass custom data to your webhook.
Arbitrary JSON objects are supported.
If supplied, the value is used to populate the
WebhookRequest.original_detect_intent_request.payload
field sent to your webhook.
Generated from protobuf field .google.protobuf.Struct payload = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasPayload
clearPayload
setPayload
This field can be used to pass custom data to your webhook.
Arbitrary JSON objects are supported.
If supplied, the value is used to populate the
WebhookRequest.original_detect_intent_request.payload
field sent to your webhook.
Generated from protobuf field .google.protobuf.Struct payload = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSentimentAnalysisRequestConfig
Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.
Generated from protobuf field .google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\SentimentAnalysisRequestConfig|null | |
hasSentimentAnalysisRequestConfig
clearSentimentAnalysisRequestConfig
setSentimentAnalysisRequestConfig
Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.
Generated from protobuf field .google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\SentimentAnalysisRequestConfig
|
| 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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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.
Generated from protobuf field map<string, string> webhook_headers = 14;
| 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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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.
Generated from protobuf field map<string, string> webhook_headers = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |