Struct GoogleCloudDialogflowCxV3QueryParameters

pub struct GoogleCloudDialogflowCxV3QueryParameters {

    pub analyze_query_text_sentiment: Option<bool>,
    pub channel: Option<String>,
    pub current_page: Option<String>,
    pub disable_webhook: Option<bool>,
    pub end_user_metadata: Option<HashMap<String, Value>>,
    pub flow_versions: Option<Vec<String>>,
    pub geo_location: Option<GoogleTypeLatLng>,
    pub parameters: Option<HashMap<String, Value>>,
    pub payload: Option<HashMap<String, Value>>,
    pub populate_data_store_connection_signals: Option<bool>,
    pub search_config: Option<GoogleCloudDialogflowCxV3SearchConfig>,
    pub session_entity_types: Option<Vec<GoogleCloudDialogflowCxV3SessionEntityType>>,
    pub session_ttl: Option<Duration>,
    pub time_zone: Option<String>,
    pub webhook_headers: Option<HashMap<String, String>>,
}

Represents the parameters of a conversational query.

This type is not used in any activity, and only used as part of another schema.

Fields

analyze_query_text_sentiment: Option<bool>

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.

channel: Option<String>

The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.

current_page: Option<String>

The unique identifier of the page to override the current page in the session. Format: projects//locations//agents//flows//pages/. If current_page is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.

disable_webhook: Option<bool>

Whether to disable webhook calls for this request.

end_user_metadata: Option<HashMap<String, Value>>

Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] }

flow_versions: Option<Vec<String>>

A list of flow versions to override for the request. Format: projects//locations//agents//flows//versions/. 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.

geo_location: Option<GoogleTypeLatLng>

The geo location of this conversational query.

parameters: Option<HashMap<String, Value>>

Additional parameters to be put into session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter’s entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

payload: Option<HashMap<String, Value>>

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

populate_data_store_connection_signals: Option<bool>

Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.

search_config: Option<GoogleCloudDialogflowCxV3SearchConfig>

Optional. Search configuration for UCS search queries.

session_entity_types: Option<Vec<GoogleCloudDialogflowCxV3SessionEntityType>>

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.

session_ttl: Option<Duration>

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

time_zone: Option<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.

webhook_headers: Option<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 GoogleCloudDialogflowCxV3QueryParameters

fn clone(&self) -> GoogleCloudDialogflowCxV3QueryParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleCloudDialogflowCxV3QueryParameters

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

Formats the value using the given formatter.

impl Default for GoogleCloudDialogflowCxV3QueryParameters

fn default() -> GoogleCloudDialogflowCxV3QueryParameters

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudDialogflowCxV3QueryParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoogleCloudDialogflowCxV3QueryParameters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for GoogleCloudDialogflowCxV3QueryParameters