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.



3219
3220
3221
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3219

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

Instance Attribute Details

#analyze_query_text_sentiment ⇒ Boolean 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) 


3156
3157
3158
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3156

def analyze_query_text_sentiment
  @analyze_query_text_sentiment
end

#disable_webhook ⇒ Boolean Also known as: disable_webhook?

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

Returns:

  • (Boolean) 


3162
3163
3164
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3162

def disable_webhook
  @disable_webhook
end

#geo_location ⇒ Google::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 must conform to the WGS84 standard. Values must be within normalized ranges. Corresponds to the JSON property geoLocation

Returns:



3171
3172
3173
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3171

def geo_location
  @geo_location
end

#parameters ⇒ Hash<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. 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

Returns:

  • (Hash<String,Object>) 


3185
3186
3187
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3185

def parameters
  @parameters
end

#payload ⇒ Hash<String,Object>

This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Corresponds to the JSON property payload

Returns:

  • (Hash<String,Object>) 


3191
3192
3193
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3191

def payload
  @payload
end

#session_entity_types ⇒ Array<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

Returns:



3198
3199
3200
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3198

def session_entity_types
  @session_entity_types
end

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

Returns:

  • (String) 


3205
3206
3207
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3205

def time_zone
  @time_zone
end

#webhook_headers ⇒ Hash<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>) 


3217
3218
3219
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3217

def webhook_headers
  @webhook_headers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3224

def update!(**args)
  @analyze_query_text_sentiment = args[:analyze_query_text_sentiment] if args.key?(:analyze_query_text_sentiment)
  @disable_webhook = args[:disable_webhook] if args.key?(:disable_webhook)
  @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