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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/session_entity_type.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.

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:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb', line 51

class SessionEntityType
  include Google::Protobuf::MessageExts
  extend Google::Protobuf::MessageExts::ClassMethods

  # 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 custom entity type.
    ENTITY_OVERRIDE_MODE_OVERRIDE = 1

    # The collection of session entities extends the collection of entities in
    # the corresponding custom entity type.
    #
    # Note: Even in this override mode calls to `ListSessionEntityTypes`,
    # `GetSessionEntityType`, `CreateSessionEntityType` and
    # `UpdateSessionEntityType` only return the additional entities added in
    # this session entity type. If you want to get the supplemented list,
    # please call {Google::Cloud::Dialogflow::V2::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType} on the custom entity type
    # and merge.
    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 custom entity type definition.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb', line 51

class SessionEntityType
  include Google::Protobuf::MessageExts
  extend Google::Protobuf::MessageExts::ClassMethods

  # 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 custom entity type.
    ENTITY_OVERRIDE_MODE_OVERRIDE = 1

    # The collection of session entities extends the collection of entities in
    # the corresponding custom entity type.
    #
    # Note: Even in this override mode calls to `ListSessionEntityTypes`,
    # `GetSessionEntityType`, `CreateSessionEntityType` and
    # `UpdateSessionEntityType` only return the additional entities added in
    # this session entity type. If you want to get the supplemented list,
    # please call {Google::Cloud::Dialogflow::V2::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType} on the custom entity type
    # and merge.
    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>, 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.

Returns:

  • (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.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb', line 51

class SessionEntityType
  include Google::Protobuf::MessageExts
  extend Google::Protobuf::MessageExts::ClassMethods

  # 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 custom entity type.
    ENTITY_OVERRIDE_MODE_OVERRIDE = 1

    # The collection of session entities extends the collection of entities in
    # the corresponding custom entity type.
    #
    # Note: Even in this override mode calls to `ListSessionEntityTypes`,
    # `GetSessionEntityType`, `CreateSessionEntityType` and
    # `UpdateSessionEntityType` only return the additional entities added in
    # this session entity type. If you want to get the supplemented list,
    # please call {Google::Cloud::Dialogflow::V2::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType} on the custom entity type
    # and merge.
    ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
  end
end