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



4040
4041
4042
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4040

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

Instance Attribute Details

#contextsArray<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context>

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



3989
3990
3991
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3989

def contexts
  @contexts
end

#geo_locationGoogle::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



3998
3999
4000
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3998

def geo_location
  @geo_location
end

#knowledge_base_namesArray<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>)


4005
4006
4007
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4005

def knowledge_base_names
  @knowledge_base_names
end

#payloadHash<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>)


4011
4012
4013
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4011

def payload
  @payload
end

#reset_contextsBoolean 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)


4017
4018
4019
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4017

def reset_contexts
  @reset_contexts
end

#sentiment_analysis_request_configGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig

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



4023
4024
4025
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4023

def sentiment_analysis_request_config
  @sentiment_analysis_request_config
end

#session_entity_typesArray<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



4030
4031
4032
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4030

def session_entity_types
  @session_entity_types
end

#time_zoneString

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)


4038
4039
4040
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4038

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4045

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