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:



42
43
44
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 42

class EntityType
  # Optional. Represents an entity.
  # @!attribute [rw] value
  #   @return [String]
  #     Required.
  #     For `KIND_MAP` entity types:
  #       A canonical name 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 synonyms. For `KIND_LIST` entity types this
  #     must contain exactly one synonym equal to `value`.
  class Entity; 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
  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.

Returns:

  • (String) —

    Required. The name of the entity.



42
43
44
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 42

class EntityType
  # Optional. Represents an entity.
  # @!attribute [rw] value
  #   @return [String]
  #     Required.
  #     For `KIND_MAP` entity types:
  #       A canonical name 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 synonyms. For `KIND_LIST` entity types this
  #     must contain exactly one synonym equal to `value`.
  class Entity; 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
  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 entities associated with the entity type.

Returns:



42
43
44
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 42

class EntityType
  # Optional. Represents an entity.
  # @!attribute [rw] value
  #   @return [String]
  #     Required.
  #     For `KIND_MAP` entity types:
  #       A canonical name 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 synonyms. For `KIND_LIST` entity types this
  #     must contain exactly one synonym equal to `value`.
  class Entity; 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
  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:



42
43
44
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 42

class EntityType
  # Optional. Represents an entity.
  # @!attribute [rw] value
  #   @return [String]
  #     Required.
  #     For `KIND_MAP` entity types:
  #       A canonical name 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 synonyms. For `KIND_LIST` entity types this
  #     must contain exactly one synonym equal to `value`.
  class Entity; 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
  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 Required for all methods except create (create populates the name automatically. The unique identifier of the entity type. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

Returns:

  • (String) —

    Required for all methods except create (create populates the name automatically. The unique identifier of the entity type. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.



42
43
44
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
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb', line 42

class EntityType
  # Optional. Represents an entity.
  # @!attribute [rw] value
  #   @return [String]
  #     Required.
  #     For `KIND_MAP` entity types:
  #       A canonical name 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 synonyms. For `KIND_LIST` entity types this
  #     must contain exactly one synonym equal to `value`.
  class Entity; 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
  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