Class: Google::Cloud::Dialogflow::V2::SessionEntityType

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb

Overview

Represents a session entity type.

Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as "developer entity types").

Note: session entity types apply to all queries, regardless of the language.

Defined Under Namespace

Modules: EntityOverrideMode

Instance Attribute Summary collapse

Instance Attribute Details

#entities ⇒ Array<Google::Cloud::Dialogflow::V2::EntityType::Entity>

Returns Required. The collection of entities associated with this session entity type.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb', line 40

class SessionEntityType
  # The types of modifications for a session entity type.
  module EntityOverrideMode
    # Not specified. This value should be never used.
    ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0

    # The collection of session entities overrides the collection of entities
    # in the corresponding developer entity type.
    ENTITY_OVERRIDE_MODE_OVERRIDE = 1

    # The collection of session entities extends the collection of entities in
    # the corresponding developer entity type.
    # Calls to `ListSessionEntityTypes`, `GetSessionEntityType`,
    # `CreateSessionEntityType` and `UpdateSessionEntityType` return the full
    # collection of entities from the developer entity type in the agent's
    # default language and the session entity type.
    ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
  end
end

#entity_override_mode ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode

Returns Required. Indicates whether the additional data should override or supplement the developer entity type definition.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb', line 40

class SessionEntityType
  # The types of modifications for a session entity type.
  module EntityOverrideMode
    # Not specified. This value should be never used.
    ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0

    # The collection of session entities overrides the collection of entities
    # in the corresponding developer entity type.
    ENTITY_OVERRIDE_MODE_OVERRIDE = 1

    # The collection of session entities extends the collection of entities in
    # the corresponding developer entity type.
    # Calls to `ListSessionEntityTypes`, `GetSessionEntityType`,
    # `CreateSessionEntityType` and `UpdateSessionEntityType` return the full
    # collection of entities from the developer entity type in the agent's
    # default language and the session entity type.
    ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
  end
end

#name ⇒ String

Returns Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>.

Returns:

  • (String) —

    Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb', line 40

class SessionEntityType
  # The types of modifications for a session entity type.
  module EntityOverrideMode
    # Not specified. This value should be never used.
    ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0

    # The collection of session entities overrides the collection of entities
    # in the corresponding developer entity type.
    ENTITY_OVERRIDE_MODE_OVERRIDE = 1

    # The collection of session entities extends the collection of entities in
    # the corresponding developer entity type.
    # Calls to `ListSessionEntityTypes`, `GetSessionEntityType`,
    # `CreateSessionEntityType` and `UpdateSessionEntityType` return the full
    # collection of entities from the developer entity type in the agent's
    # default language and the session entity type.
    ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
  end
end