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.



5772
5773
5774
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5772

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:



5701
5702
5703
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5701

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:



5710
5711
5712
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5710

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


5717
5718
5719
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5717

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


5723
5724
5725
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5723

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) 


5729
5730
5731
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5729

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:



5735
5736
5737
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5735

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:



5742
5743
5744
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5742

def session_entity_types
  @session_entity_types
end

#sub_agents ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SubAgent>

Optional. For mega agent query, directly specify which sub agents to query. If any specified sub agent is not linked to the mega agent, an error will be returned. If empty, Dialogflow will decide which sub agents to query. If specified for a non-mega-agent query, will be silently ignored. Corresponds to the JSON property subAgents

Returns:



5750
5751
5752
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5750

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


5758
5759
5760
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5758

def time_zone
  @time_zone
end

#webhook_headers ⇒ Hash<String,String>

Optional. This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook alone 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>) 


5770
5771
5772
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5770

def webhook_headers
  @webhook_headers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 5777

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