Class QueryParameters

Represents the parameters of a conversational query.

Attributes
NameDescription
strtime_zone
The time zone of this conversational query from the `time zone database
google.type.latlng_pb2.LatLnggeo_location
The geo location of this conversational query.
Sequence[google.cloud.dialogflowcx_v3beta1.types.SessionEntityType]session_entity_types
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.
google.protobuf.struct_pb2.Structpayload
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" } }
google.protobuf.struct_pb2.Structparameters
Additional parameters to be put into [session parameters][SessionInfo.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: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value
strcurrent_page
The unique identifier of the page to override the `current page][QueryResult.current_page]` in the session. Format: ``projects/
booldisable_webhook
Whether to disable webhook calls for this request.
boolanalyze_query_text_sentiment
Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
Sequence[google.cloud.dialogflowcx_v3beta1.types.QueryParameters.WebhookHeadersEntry]webhook_headers
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.
Sequence[str]flow_versions
A list of flow versions to override for the request. Format: ``projects/

Inheritance

builtins.object > proto.message.Message > QueryParameters

Classes

WebhookHeadersEntry

WebhookHeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API documentation for dialogflowcx_v3beta1.types.QueryParameters.WebhookHeadersEntry class.