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

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

Overview

Represents the parameters of the conversational query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2QueryParameters

Returns a new instance of GoogleCloudDialogflowV2QueryParameters

[View source]

2008
2009
2010
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2008

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

Instance Attribute Details

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

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

Returns:


1969
1970
1971
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1969

def contexts
  @contexts
end

#geo_location ⇒ Google::Apis::DialogflowV2::GoogleTypeLatLng

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing 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:


1978
1979
1980
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1978

def geo_location
  @geo_location
end

#payload ⇒ Hash<String,Object>

Optional. 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>) 

1984
1985
1986
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1984

def payload
  @payload
end

#reset_contexts ⇒ Boolean Also known as: reset_contexts?

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

Returns:

  • (Boolean) 

1990
1991
1992
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1990

def reset_contexts
  @reset_contexts
end

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

Optional. 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:


1998
1999
2000
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 1998

def session_entity_types
  @session_entity_types
end

#time_zone ⇒ String

Optional. 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) 

2006
2007
2008
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2006

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2013

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)
  @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts)
  @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end