Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Context

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

Overview

Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the Contexts guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2Context

Returns a new instance of GoogleCloudDialogflowV2Context.



9929
9930
9931
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9929

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

Instance Attribute Details

#lifespan_count ⇒ Fixnum

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. Corresponds to the JSON property lifespanCount

Returns:

  • (Fixnum) 


9901
9902
9903
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9901

def lifespan_count
  @lifespan_count
end

#name ⇒ String

Required. The unique identifier of the context. Format: projects//agent/ sessions//contexts/, or projects//agent/environments//users//sessions// contexts/. The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * * _id_dialog_context * *_dialog_params_size Corresponds to the JSON property name

Returns:

  • (String) 


9914
9915
9916
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9914

def name
  @name
end

#parameters ⇒ Hash<String,Object>

Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value Corresponds to the JSON property parameters

Returns:

  • (Hash<String,Object>) 


9927
9928
9929
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9927

def parameters
  @parameters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9934
9935
9936
9937
9938
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9934

def update!(**args)
  @lifespan_count = args[:lifespan_count] if args.key?(:lifespan_count)
  @name = args[:name] if args.key?(:name)
  @parameters = args[:parameters] if args.key?(:parameters)
end