Custom entities

You can create custom entities for matching data specific to your agent. For example, you could define a vegetable entity type that can match the types of vegetables available for purchase with a grocery store agent.

Note: When building your agent, it's best to define your entities prior to adding training phrases to your intents. The console will automatically annotate your training phrases with existing entities. However, if you create entities after training phrases, you can manually annotate the phrases.

Create custom entities

To create a custom entity:

Console

1. Open the Dialogflow CX Console.
2. Choose your GCP project.
3. Select your agent.
4. Select the Manage tab.
5. Click Entity Types.
6. Click Create.
7. Enter entity data.
8. Click Save.

API

Use the EntityType's create method. Go to the EntityType API reference

Select a protocol and version for the EntityType reference:

Protocol	V3	V3beta1
REST	EntityType resource	EntityType resource
RPC	EntityType interface	EntityType interface
C++	EntityTypesClient	Not available
C#	EntityTypesClient	Not available
Go	EntityTypesClient	Not available
Java	EntityTypesClient	EntityTypesClient
Node.js	EntityTypesClient	EntityTypesClient
PHP	Not available	Not available
Python	EntityTypesClient	EntityTypesClient
Ruby	Not available	Not available

Close

Limitations

The following limitations apply:

• Custom entity type display names are unique for each agent. Entity type display names should start with a letter and can contain the following: A-Z, a-z, 0-9, _ (underscore), - (dash). Entity reference and synonym values have no such limitation.