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



3920
3921
3922
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3920

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



3866
3867
3868
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3866

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



3875
3876
3877
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3875

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>. Note: This field is repeated for forward compatibility, currently only the first one is supported, we may return an error if multiple KnowledgeBases are specified. Corresponds to the JSON property knowledgeBaseNames

Returns:

  • (Array<String>)


3885
3886
3887
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3885

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


3891
3892
3893
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3891

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)


3897
3898
3899
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3897

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



3903
3904
3905
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3903

def sentiment_analysis_request_config
  @sentiment_analysis_request_config
end

#session_entity_typesArray<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType>

Optional. The collection of session entity types to replace or extend developer entities with for this query only. The entity synonyms apply to all languages. Corresponds to the JSON property sessionEntityTypes



3910
3911
3912
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3910

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)


3918
3919
3920
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3918

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3925

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