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

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

Overview

Represents the parameters of the conversational query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1QueryParameters

Returns a new instance of GoogleCloudDialogflowV2beta1QueryParameters.



13023
13024
13025
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13023

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

Instance Attribute Details

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

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

Returns:



12952
12953
12954
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12952

def contexts
  @contexts
end

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



12960
12961
12962
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12960

def geo_location
  @geo_location
end

#knowledge_base_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 


12967
12968
12969
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12967

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


12975
12976
12977
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12975

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


12981
12982
12983
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12981

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:



12987
12988
12989
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12987

def sentiment_analysis_request_config
  @sentiment_analysis_request_config
end

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

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:



12994
12995
12996
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12994

def session_entity_types
  @session_entity_types
end

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

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:



13002
13003
13004
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13002

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


13009
13010
13011
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13009

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


13021
13022
13023
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13021

def webhook_headers
  @webhook_headers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 13028

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