Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SessionEntityType

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

A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the session entity guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2SessionEntityType

Returns a new instance of GoogleCloudDialogflowV2SessionEntityType.



15446
15447
15448
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15446

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

Instance Attribute Details

#entities ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EntityTypeEntity>

Required. The collection of entities associated with this session entity type. Corresponds to the JSON property entities

Returns:



15428
15429
15430
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15428

def entities
  @entities
end

#entity_override_mode ⇒ String

Required. Indicates whether the additional data should override or supplement the custom entity type definition. Corresponds to the JSON property entityOverrideMode

Returns:

  • (String) 


15434
15435
15436
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15434

def entity_override_mode
  @entity_override_mode
end

#name ⇒ String

Required. The unique identifier of this session entity type. Format: projects/ /agent/sessions//entityTypes/, or projects//agent/environments//users// sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default ' -' user. `must be the display name of an existing entity type in the same agent that will be overridden or supplemented. Corresponds to the JSON propertyname`

Returns:

  • (String) 


15444
15445
15446
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15444

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15451
15452
15453
15454
15455
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 15451

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