Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3QueryParameters

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb

Overview

Represents the parameters of a conversational query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3QueryParameters

Returns a new instance of GoogleCloudDialogflowCxV3QueryParameters.



5995
5996
5997
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5995

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#analyze_query_text_sentimentBoolean Also known as: analyze_query_text_sentiment?

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. Corresponds to the JSON property analyzeQueryTextSentiment

Returns:

  • (Boolean)


5868
5869
5870
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5868

def analyze_query_text_sentiment
  @analyze_query_text_sentiment
end

#channelString

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. Corresponds to the JSON property channel

Returns:

  • (String)


5878
5879
5880
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5878

def channel
  @channel
end

#current_pageString

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

Returns:

  • (String)


5888
5889
5890
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5888

def current_page
  @current_page
end

#disable_webhookBoolean Also known as: disable_webhook?

Whether to disable webhook calls for this request. Corresponds to the JSON property disableWebhook

Returns:

  • (Boolean)


5893
5894
5895
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5893

def disable_webhook
  @disable_webhook
end

#end_user_metadataHash<String,Object>

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"` ] ` Corresponds to the JSON property endUserMetadata

Returns:

  • (Hash<String,Object>)


5904
5905
5906
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5904

def 
  @end_user_metadata
end

#flow_versionsArray<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. Corresponds to the JSON property flowVersions

Returns:

  • (Array<String>)


5913
5914
5915
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5913

def flow_versions
  @flow_versions
end

#geo_locationGoogle::Apis::DialogflowV3::GoogleTypeLatLng

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



5921
5922
5923
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5921

def geo_location
  @geo_location
end

#parametersHash<String,Object>

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. Corresponds to the JSON property parameters

Returns:

  • (Hash<String,Object>)


5937
5938
5939
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5937

def parameters
  @parameters
end

#payloadHash<String,Object>

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

Returns:

  • (Hash<String,Object>)


5946
5947
5948
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5946

def payload
  @payload
end

#populate_data_store_connection_signalsBoolean Also known as: populate_data_store_connection_signals?

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. Corresponds to the JSON property populateDataStoreConnectionSignals

Returns:

  • (Boolean)


5953
5954
5955
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5953

def populate_data_store_connection_signals
  @populate_data_store_connection_signals
end

#search_configGoogle::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SearchConfig

Search configuration for UCS search queries. Corresponds to the JSON property searchConfig



5959
5960
5961
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5959

def search_config
  @search_config
end

#session_entity_typesArray<Google::Apis::DialogflowV3::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. Corresponds to the JSON property sessionEntityTypes



5966
5967
5968
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5966

def session_entity_types
  @session_entity_types
end

#session_ttlString

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. Corresponds to the JSON property sessionTtl

Returns:

  • (String)


5974
5975
5976
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5974

def session_ttl
  @session_ttl
end

#time_zoneString

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. Corresponds to the JSON property timeZone

Returns:

  • (String)


5981
5982
5983
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5981

def time_zone
  @time_zone
end

#webhook_headersHash<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. Corresponds to the JSON property webhookHeaders

Returns:

  • (Hash<String,String>)


5993
5994
5995
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 5993

def webhook_headers
  @webhook_headers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6000

def update!(**args)
  @analyze_query_text_sentiment = args[:analyze_query_text_sentiment] if args.key?(:analyze_query_text_sentiment)
  @channel = args[:channel] if args.key?(:channel)
  @current_page = args[:current_page] if args.key?(:current_page)
  @disable_webhook = args[:disable_webhook] if args.key?(:disable_webhook)
  @end_user_metadata = args[:end_user_metadata] if args.key?(:end_user_metadata)
  @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)
  @populate_data_store_connection_signals = args[:populate_data_store_connection_signals] if args.key?(:populate_data_store_connection_signals)
  @search_config = args[:search_config] if args.key?(:search_config)
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)
  @session_ttl = args[:session_ttl] if args.key?(:session_ttl)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @webhook_headers = args[:webhook_headers] if args.key?(:webhook_headers)
end