Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SessionEntityType

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

Overview

Represents a session entity type. Extends or replaces a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language.

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

Returns a new instance of GoogleCloudDialogflowV2beta1SessionEntityType.



6155
6156
6157
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 6155

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

Instance Attribute Details

#entities ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1EntityTypeEntity>

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

Returns:



6134
6135
6136
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 6134

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) 


6140
6141
6142
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 6140

def entity_override_mode
  @entity_override_mode
end

#name ⇒ String

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

Returns:

  • (String) 


6153
6154
6155
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 6153

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6160
6161
6162
6163
6164
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 6160

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