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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v3/classes.rb,
generated/google/apis/dialogflow_v3/representations.rb,
generated/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.



8795
8796
8797
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 8795

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

Instance Attribute Details

#entitiesArray<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EntityTypeEntity>

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



8777
8778
8779
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 8777

def entities
  @entities
end

#entity_override_modeString

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

Returns:

  • (String)


8783
8784
8785
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 8783

def entity_override_mode
  @entity_override_mode
end

#nameString

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)


8793
8794
8795
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 8793

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8800
8801
8802
8803
8804
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 8800

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