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

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

Overview

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.

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:



45
46
47
48
49
50
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
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 45

class EntityType
  # 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 canonical 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; 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

  # 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 canonical
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to canonical
    # 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
end

#display_name ⇒ String

Returns Required. The name of the entity type.

Returns:

  • (String) —

    Required. The name of the entity type.



45
46
47
48
49
50
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
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 45

class EntityType
  # 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 canonical 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; 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

  # 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 canonical
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to canonical
    # 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
end

#enable_fuzzy_extraction ⇒ true, false

Returns Optional. Enables fuzzy entity extraction during classification.

Returns:

  • (true, false) —

    Optional. Enables fuzzy entity extraction during classification.



45
46
47
48
49
50
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
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 45

class EntityType
  # 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 canonical 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; 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

  # 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 canonical
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to canonical
    # 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
end

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

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

Returns:



45
46
47
48
49
50
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
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 45

class EntityType
  # 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 canonical 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; 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

  # 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 canonical
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to canonical
    # 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
end

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

Returns Required. Indicates the kind of entity type.

Returns:



45
46
47
48
49
50
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
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 45

class EntityType
  # 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 canonical 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; 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

  # 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 canonical
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to canonical
    # 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
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:

  • (String) —

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



45
46
47
48
49
50
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
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 45

class EntityType
  # 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 canonical 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; 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

  # 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 canonical
    # value.
    KIND_MAP = 1

    # List entity types contain a set of entries that do not map to canonical
    # 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
end