Struct googapis::google::cloud::dialogflow::cx::v3beta1::QueryParameters [−][src]
pub struct QueryParameters {
pub time_zone: String,
pub geo_location: Option<LatLng>,
pub session_entity_types: Vec<SessionEntityType>,
pub payload: Option<Struct>,
pub parameters: Option<Struct>,
pub current_page: String,
pub disable_webhook: bool,
pub analyze_query_text_sentiment: bool,
pub webhook_headers: HashMap<String, String>,
pub flow_versions: Vec<String>,
}
Expand description
Represents the parameters of a conversational query.
Fields
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: Option<LatLng>
The geo location of this conversational query.
session_entity_types: Vec<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: Option<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:
{
"telephony": {
"caller_id": "+18558363987"
}
}
parameters: Option<Struct>
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
current_page: String
The unique identifier of the [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
page][QueryResult.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][QueryResult.current_page] and the [previous session
parameters][QueryResult.parameters].
In most cases, [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page] and
[parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters] should be configured together to
direct a session to a specific state.
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: HashMap<String, String>
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: Vec<String>
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.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for QueryParameters
impl Send for QueryParameters
impl Sync for QueryParameters
impl Unpin for QueryParameters
impl UnwindSafe for QueryParameters
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more