Class QueryParameters (2.25.0)

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

Represents the parameters of the conversational query.

Attributes

NameDescription
time_zone str
The time zone of this conversational query from the `time zone database
geo_location google.type.latlng_pb2.LatLng
The geo location of this conversational query.
contexts MutableSequence[google.cloud.dialogflow_v2beta1.types.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 MutableSequence[google.cloud.dialogflow_v2beta1.types.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_pb2.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 WebhookRequest.original_detect_intent_request.payload field sent to your webhook.
knowledge_base_names MutableSequence[str]
KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: projects/.
sentiment_analysis_request_config google.cloud.dialogflow_v2beta1.types.SentimentAnalysisRequestConfig
Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Essentials Edition agents.
sub_agents MutableSequence[google.cloud.dialogflow_v2beta1.types.SubAgent]
For mega agent query, directly specify which sub agents to query. If any specified sub agent is not linked to the mega agent, an error will be returned. If empty, Dialogflow will decide which sub agents to query. If specified for a non-mega-agent query, will be silently ignored.
webhook_headers MutableMapping[str, str]
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.
platform str
The platform of the virtual agent response messages. If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform.

Classes

WebhookHeadersEntry

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

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.