Class EntityType (2.27.0)

EntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 <https://cloud.google.com/dialogflow/docs/entities-overview>__.

Attributes

NameDescription
name str
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects/.
display_name str
Required. The name of the entity type.
kind google.cloud.dialogflow_v2.types.EntityType.Kind
Required. Indicates the kind of entity type.
auto_expansion_mode google.cloud.dialogflow_v2.types.EntityType.AutoExpansionMode
Optional. Indicates whether the entity type can be automatically expanded.
entities MutableSequence[google.cloud.dialogflow_v2.types.EntityType.Entity]
Optional. The collection of entity entries associated with the entity type.
enable_fuzzy_extraction bool
Optional. Enables fuzzy entity extraction during classification.

Classes

AutoExpansionMode

AutoExpansionMode(value)

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).

Values: AUTO_EXPANSION_MODE_UNSPECIFIED (0): Auto expansion disabled for the entity. AUTO_EXPANSION_MODE_DEFAULT (1): Allows an agent to recognize values that have not been explicitly listed in the entity.

Entity

Entity(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An entity entry for an associated entity type.

Kind

Kind(value)

Represents kinds of entities.

Values: KIND_UNSPECIFIED (0): Not specified. This value should be never used. KIND_MAP (1): Map entity types allow mapping of a group of synonyms to a reference value. KIND_LIST (2): 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_REGEXP (3): Regexp entity types allow to specify regular expressions in entries values.