REST Resource: projects.agent.entityTypes

Stay organized with collections Save and categorize content based on your preferences.

Resource: EntityType

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.

JSON representation
{
  "name": string,
  "displayName": string,
  "kind": enum (Kind),
  "autoExpansionMode": enum (AutoExpansionMode),
  "entities": [
    {
      object (Entity)
    }
  ],
  "enableFuzzyExtraction": boolean
}
Fields
name

string

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

displayName

string

Required. The name of the entity type.

kind

enum (Kind)

Required. Indicates the kind of entity type.

autoExpansionMode

enum (AutoExpansionMode)

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

entities[]

object (Entity)

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

enableFuzzyExtraction

boolean

Optional. Enables fuzzy entity extraction during classification.

Kind

Represents kinds of entities.

Enums
KIND_UNSPECIFIED Not specified. This value should be never used.
KIND_MAP Map entity types allow mapping of a group of synonyms to a reference value.
KIND_LIST 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 Regexp entity types allow to specify regular expressions in entries values.

AutoExpansionMode

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

Enums
AUTO_EXPANSION_MODE_UNSPECIFIED Auto expansion disabled for the entity.
AUTO_EXPANSION_MODE_DEFAULT Allows an agent to recognize values that have not been explicitly listed in the entity.

Methods

batchDelete

Deletes entity types in the specified agent.

batchUpdate

Updates/Creates multiple entity types in the specified agent.

create

Creates an entity type in the specified agent.

delete

Deletes the specified entity type.

get

Retrieves the specified entity type.

list

Returns the list of all entity types in the specified agent.

patch

Updates the specified entity type.