Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryParameters

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

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) ⇒ GoogleCloudDialogflowV2beta1QueryParameters

Returns a new instance of GoogleCloudDialogflowV2beta1QueryParameters



5196
5197
5198
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5196

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

Instance Attribute Details

#contexts ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context>

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

Returns:



5145
5146
5147
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5145

def contexts
  @contexts
end

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



5154
5155
5156
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5154

def geo_location
  @geo_location
end

#knowledge_base_names ⇒ Array<String>

Optional. KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>. Corresponds to the JSON property knowledgeBaseNames

Returns:

  • (Array<String>) 


5161
5162
5163
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5161

def knowledge_base_names
  @knowledge_base_names
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>) 


5167
5168
5169
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5167

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) 


5173
5174
5175
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5173

def reset_contexts
  @reset_contexts
end

#sentiment_analysis_request_config ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig

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

Returns:



5179
5180
5181
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5179

def sentiment_analysis_request_config
  @sentiment_analysis_request_config
end

#session_entity_types ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType>

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:



5186
5187
5188
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5186

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) 


5194
5195
5196
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5194

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5201

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