Struct gapi_grpc::google::cloud::dialogflow::cx::v3beta1::QueryParameters

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>,
}

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>/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.

Trait Implementations

impl Clone for QueryParameters

fn clone(&self) -> QueryParameters

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryParameters

fn default() -> QueryParameters

Returns the “default value” for a type.

impl Message for QueryParameters

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub 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.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<QueryParameters> for QueryParameters

fn eq(&self, other: &QueryParameters) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &QueryParameters) -> bool

This method tests for !=.

impl StructuralPartialEq for QueryParameters