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.



16861
16862
16863
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16861

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:



16783
16784
16785
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16783

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:



16791
16792
16793
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16791

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


16798
16799
16800
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16798

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


16806
16807
16808
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16806

def payload
  @payload
end

#platform ⇒ String

The platform of the virtual agent response messages. If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform. Corresponds to the JSON property platform

Returns:

  • (String) 


16813
16814
16815
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16813

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


16819
16820
16821
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16819

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:



16825
16826
16827
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16825

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:



16832
16833
16834
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16832

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:



16840
16841
16842
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16840

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) 


16847
16848
16849
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16847

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


16859
16860
16861
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16859

def webhook_headers
  @webhook_headers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 16866

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