Class: Google::Cloud::Dialogflow::V2::EntityType

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/entity_type.rb

Overview

Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.

Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent.

For more information, see the Entity guide.

Defined Under Namespace

Modules: AutoExpansionMode, Kind Classes: Entity

Instance Attribute Summary collapse

Instance Attribute Details

#auto_expansion_mode ⇒ ::Google::Cloud::Dialogflow::V2::EntityType::AutoExpansionMode

Returns Optional. Indicates whether the entity type can be automatically expanded.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/entity_type.rb', line 61

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

  # An **entity entry** for an associated entity type.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The primary value associated with this entity entry.
  #     For example, if the entity type is *vegetable*, the value could be
  #     *scallions*.
  #
  #     For `KIND_MAP` entity types:
  #
  #     *   A reference value to be used in place of synonyms.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   A string that can contain references to other entity types (with or
  #         without aliases).
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Required. A collection of value synonyms. For example, if the entity type
  #     is *vegetable*, and `value` is *scallions*, a synonym could be *green
  #     onions*.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   This collection must contain exactly one synonym equal to `value`.
  class Entity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents kinds of entities.
  module Kind
    # Not specified. This value should be never used.
    KIND_UNSPECIFIED = 0

    # Map entity types allow mapping of a group of synonyms to a reference
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to reference
    # values. However, list entity types can contain references to other entity
    # types (with or without aliases).
    KIND_LIST = 2

    # Regexp entity types allow to specify regular expressions in entries
    # values.
    KIND_REGEXP = 3
  end

  # Represents different entity type expansion modes. Automated expansion
  # allows an agent to recognize values that have not been explicitly listed in
  # the entity (for example, new kinds of shopping list items).
  module AutoExpansionMode
    # Auto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_UNSPECIFIED = 0

    # Allows an agent to recognize values that have not been explicitly
    # listed in the entity.
    AUTO_EXPANSION_MODE_DEFAULT = 1
  end
end

#display_name ⇒ ::String

Returns Required. The name of the entity type.

Returns:

  • (::String) —

    Required. The name of the entity type.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/entity_type.rb', line 61

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

  # An **entity entry** for an associated entity type.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The primary value associated with this entity entry.
  #     For example, if the entity type is *vegetable*, the value could be
  #     *scallions*.
  #
  #     For `KIND_MAP` entity types:
  #
  #     *   A reference value to be used in place of synonyms.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   A string that can contain references to other entity types (with or
  #         without aliases).
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Required. A collection of value synonyms. For example, if the entity type
  #     is *vegetable*, and `value` is *scallions*, a synonym could be *green
  #     onions*.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   This collection must contain exactly one synonym equal to `value`.
  class Entity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents kinds of entities.
  module Kind
    # Not specified. This value should be never used.
    KIND_UNSPECIFIED = 0

    # Map entity types allow mapping of a group of synonyms to a reference
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to reference
    # values. However, list entity types can contain references to other entity
    # types (with or without aliases).
    KIND_LIST = 2

    # Regexp entity types allow to specify regular expressions in entries
    # values.
    KIND_REGEXP = 3
  end

  # Represents different entity type expansion modes. Automated expansion
  # allows an agent to recognize values that have not been explicitly listed in
  # the entity (for example, new kinds of shopping list items).
  module AutoExpansionMode
    # Auto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_UNSPECIFIED = 0

    # Allows an agent to recognize values that have not been explicitly
    # listed in the entity.
    AUTO_EXPANSION_MODE_DEFAULT = 1
  end
end

#enable_fuzzy_extraction ⇒ ::Boolean

Returns Optional. Enables fuzzy entity extraction during classification.

Returns:

  • (::Boolean) —

    Optional. Enables fuzzy entity extraction during classification.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/entity_type.rb', line 61

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

  # An **entity entry** for an associated entity type.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The primary value associated with this entity entry.
  #     For example, if the entity type is *vegetable*, the value could be
  #     *scallions*.
  #
  #     For `KIND_MAP` entity types:
  #
  #     *   A reference value to be used in place of synonyms.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   A string that can contain references to other entity types (with or
  #         without aliases).
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Required. A collection of value synonyms. For example, if the entity type
  #     is *vegetable*, and `value` is *scallions*, a synonym could be *green
  #     onions*.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   This collection must contain exactly one synonym equal to `value`.
  class Entity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents kinds of entities.
  module Kind
    # Not specified. This value should be never used.
    KIND_UNSPECIFIED = 0

    # Map entity types allow mapping of a group of synonyms to a reference
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to reference
    # values. However, list entity types can contain references to other entity
    # types (with or without aliases).
    KIND_LIST = 2

    # Regexp entity types allow to specify regular expressions in entries
    # values.
    KIND_REGEXP = 3
  end

  # Represents different entity type expansion modes. Automated expansion
  # allows an agent to recognize values that have not been explicitly listed in
  # the entity (for example, new kinds of shopping list items).
  module AutoExpansionMode
    # Auto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_UNSPECIFIED = 0

    # Allows an agent to recognize values that have not been explicitly
    # listed in the entity.
    AUTO_EXPANSION_MODE_DEFAULT = 1
  end
end

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

Returns Optional. The collection of entity entries associated with the entity type.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/entity_type.rb', line 61

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

  # An **entity entry** for an associated entity type.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The primary value associated with this entity entry.
  #     For example, if the entity type is *vegetable*, the value could be
  #     *scallions*.
  #
  #     For `KIND_MAP` entity types:
  #
  #     *   A reference value to be used in place of synonyms.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   A string that can contain references to other entity types (with or
  #         without aliases).
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Required. A collection of value synonyms. For example, if the entity type
  #     is *vegetable*, and `value` is *scallions*, a synonym could be *green
  #     onions*.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   This collection must contain exactly one synonym equal to `value`.
  class Entity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents kinds of entities.
  module Kind
    # Not specified. This value should be never used.
    KIND_UNSPECIFIED = 0

    # Map entity types allow mapping of a group of synonyms to a reference
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to reference
    # values. However, list entity types can contain references to other entity
    # types (with or without aliases).
    KIND_LIST = 2

    # Regexp entity types allow to specify regular expressions in entries
    # values.
    KIND_REGEXP = 3
  end

  # Represents different entity type expansion modes. Automated expansion
  # allows an agent to recognize values that have not been explicitly listed in
  # the entity (for example, new kinds of shopping list items).
  module AutoExpansionMode
    # Auto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_UNSPECIFIED = 0

    # Allows an agent to recognize values that have not been explicitly
    # listed in the entity.
    AUTO_EXPANSION_MODE_DEFAULT = 1
  end
end

#kind ⇒ ::Google::Cloud::Dialogflow::V2::EntityType::Kind

Returns Required. Indicates the kind of entity type.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/entity_type.rb', line 61

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

  # An **entity entry** for an associated entity type.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The primary value associated with this entity entry.
  #     For example, if the entity type is *vegetable*, the value could be
  #     *scallions*.
  #
  #     For `KIND_MAP` entity types:
  #
  #     *   A reference value to be used in place of synonyms.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   A string that can contain references to other entity types (with or
  #         without aliases).
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Required. A collection of value synonyms. For example, if the entity type
  #     is *vegetable*, and `value` is *scallions*, a synonym could be *green
  #     onions*.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   This collection must contain exactly one synonym equal to `value`.
  class Entity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents kinds of entities.
  module Kind
    # Not specified. This value should be never used.
    KIND_UNSPECIFIED = 0

    # Map entity types allow mapping of a group of synonyms to a reference
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to reference
    # values. However, list entity types can contain references to other entity
    # types (with or without aliases).
    KIND_LIST = 2

    # Regexp entity types allow to specify regular expressions in entries
    # values.
    KIND_REGEXP = 3
  end

  # Represents different entity type expansion modes. Automated expansion
  # allows an agent to recognize values that have not been explicitly listed in
  # the entity (for example, new kinds of shopping list items).
  module AutoExpansionMode
    # Auto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_UNSPECIFIED = 0

    # Allows an agent to recognize values that have not been explicitly
    # listed in the entity.
    AUTO_EXPANSION_MODE_DEFAULT = 1
  end
end

#name ⇒ ::String

Returns The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/entity_type.rb', line 61

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

  # An **entity entry** for an associated entity type.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The primary value associated with this entity entry.
  #     For example, if the entity type is *vegetable*, the value could be
  #     *scallions*.
  #
  #     For `KIND_MAP` entity types:
  #
  #     *   A reference value to be used in place of synonyms.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   A string that can contain references to other entity types (with or
  #         without aliases).
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Required. A collection of value synonyms. For example, if the entity type
  #     is *vegetable*, and `value` is *scallions*, a synonym could be *green
  #     onions*.
  #
  #     For `KIND_LIST` entity types:
  #
  #     *   This collection must contain exactly one synonym equal to `value`.
  class Entity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents kinds of entities.
  module Kind
    # Not specified. This value should be never used.
    KIND_UNSPECIFIED = 0

    # Map entity types allow mapping of a group of synonyms to a reference
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to reference
    # values. However, list entity types can contain references to other entity
    # types (with or without aliases).
    KIND_LIST = 2

    # Regexp entity types allow to specify regular expressions in entries
    # values.
    KIND_REGEXP = 3
  end

  # Represents different entity type expansion modes. Automated expansion
  # allows an agent to recognize values that have not been explicitly listed in
  # the entity (for example, new kinds of shopping list items).
  module AutoExpansionMode
    # Auto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_UNSPECIFIED = 0

    # Allows an agent to recognize values that have not been explicitly
    # listed in the entity.
    AUTO_EXPANSION_MODE_DEFAULT = 1
  end
end