class Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3QueryParameters

Represents the parameters of a conversational query.

Attributes

analyze_query_text_sentiment[RW]

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. Corresponds to the JSON property `analyzeQueryTextSentiment` @return [Boolean]

analyze_query_text_sentiment?[RW]

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. Corresponds to the JSON property `analyzeQueryTextSentiment` @return [Boolean]

current_page[RW]

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. Corresponds to the JSON property `currentPage` @return [String]

disable_webhook[RW]

Whether to disable webhook calls for this request. Corresponds to the JSON property `disableWebhook` @return [Boolean]

disable_webhook?[RW]

Whether to disable webhook calls for this request. Corresponds to the JSON property `disableWebhook` @return [Boolean]

flow_versions[RW]

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. Corresponds to the JSON property `flowVersions` @return [Array<String>]

geo_location[RW]

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. Corresponds to the JSON property `geoLocation` @return [Google::Apis::DialogflowV3::GoogleTypeLatLng]

parameters[RW]

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: 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 Corresponds to the JSON property `parameters` @return [Hash<String,Object>]

payload[RW]

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” ` ` “` Corresponds to the JSON property `payload` @return [Hash<String,Object>]

session_entity_types[RW]

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. Corresponds to the JSON property `sessionEntityTypes` @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType>]

time_zone[RW]

The time zone of this conversational query from the [time zone database](https: //www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used. Corresponds to the JSON property `timeZone` @return [String]

webhook_headers[RW]

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. Corresponds to the JSON property `webhookHeaders` @return [Hash<String,String>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dialogflow_v3/classes.rb, line 3554
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dialogflow_v3/classes.rb, line 3559
def update!(**args)
  @analyze_query_text_sentiment = args[:analyze_query_text_sentiment] if args.key?(:analyze_query_text_sentiment)
  @current_page = args[:current_page] if args.key?(:current_page)
  @disable_webhook = args[:disable_webhook] if args.key?(:disable_webhook)
  @flow_versions = args[:flow_versions] if args.key?(:flow_versions)
  @geo_location = args[:geo_location] if args.key?(:geo_location)
  @parameters = args[:parameters] if args.key?(:parameters)
  @payload = args[:payload] if args.key?(:payload)
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @webhook_headers = args[:webhook_headers] if args.key?(:webhook_headers)
end