Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryParameters

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

Overview

Represents the parameters of the conversational query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2QueryParameters

Returns a new instance of GoogleCloudDialogflowV2QueryParameters.



12345
12346
12347
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12345

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

Instance Attribute Details

#contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context>

The collection of contexts to be activated before this query is executed. Corresponds to the JSON property contexts

Returns:



12282
12283
12284
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12282

def contexts
  @contexts
end

#geo_location ⇒ Google::Apis::DialogflowV2::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

Returns:



12290
12291
12292
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12290

def geo_location
  @geo_location
end

#payload ⇒ Hash<String,Object>

This field can be used to pass custom data to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the WebhookRequest.original_detect_intent_request.payload field sent to your webhook. Corresponds to the JSON property payload

Returns:

  • (Hash<String,Object>) 


12298
12299
12300
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12298

def payload
  @payload
end

#platform ⇒ String

The platform of the virtual agent response messages. If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform. Corresponds to the JSON property platform

Returns:

  • (String) 


12305
12306
12307
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12305

def platform
  @platform
end

#reset_contexts ⇒ Boolean Also known as: reset_contexts?

Specifies whether to delete all contexts in the current session before the new ones are activated. Corresponds to the JSON property resetContexts

Returns:

  • (Boolean) 


12311
12312
12313
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12311

def reset_contexts
  @reset_contexts
end

#sentiment_analysis_request_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisRequestConfig

Configures the types of sentiment analysis to perform. Corresponds to the JSON property sentimentAnalysisRequestConfig

Returns:



12317
12318
12319
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12317

def sentiment_analysis_request_config
  @sentiment_analysis_request_config
end

#session_entity_types ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType>

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:



12324
12325
12326
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12324

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 agent settings is used. Corresponds to the JSON property timeZone

Returns:

  • (String) 


12331
12332
12333
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12331

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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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>) 


12343
12344
12345
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12343

def webhook_headers
  @webhook_headers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12350

def update!(**args)
  @contexts = args[:contexts] if args.key?(:contexts)
  @geo_location = args[:geo_location] if args.key?(:geo_location)
  @payload = args[:payload] if args.key?(:payload)
  @platform = args[:platform] if args.key?(:platform)
  @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts)
  @sentiment_analysis_request_config = args[:sentiment_analysis_request_config] if args.key?(:sentiment_analysis_request_config)
  @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