Stay organized with collections
Save and categorize content based on your preferences.
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.
Where to find this data
When building an agent,
it is most common to use the
Dialogflow ES console (visit documentation, open console).
The instructions below focus on using the console.
To access custom entity data:
If you are building an agent using the API instead of the console, see the
EntityTypes reference.
The API field names are similar to the console field names.
The instructions below highlight any important differences between the console and the API.
Click the first row and provide a reference value in the left column.
Click the next column or press Enter and provide synonyms.
Continue adding rows for other entity entries.
Click Save.
Batch operations
You can move, copy, or delete multiple entities using batch operations:
Copy:
Copies selected entities to the target agent.
Move:
Moves selected entities to the target agent.
Delete:
Permanently deletes the selected entities.
This cannot be undone.
The following additional options are prompted for copy and move operations:
Copy related entities:
Moves or copies entities used in
composite entities.
Overwrite entities:
Overwrites entities with the same name.
To copy, move, or delete multiple entities:
Hover you mouse over the list
and select one or more entities.
This reveals the batch options.
Choose the desired action.
Select the desired options in the dialog.
Click Start.
Limitations
The following limitations apply:
Custom entity type names are unique for each agent.
Entity type 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eCustom entities can be created to match data specific to an agent, such as defining a \u003ccode\u003evegetable\u003c/code\u003e entity for a grocery store agent.\u003c/p\u003e\n"],["\u003cp\u003eIt is recommended to define entities before adding training phrases to intents in the Dialogflow ES console, as the console will automatically annotate training phrases with existing entities.\u003c/p\u003e\n"],["\u003cp\u003eCustom entity data can be accessed by navigating to the "Entities" section in the left sidebar menu of the Dialogflow ES console and selecting the "Custom" tab.\u003c/p\u003e\n"],["\u003cp\u003eBatch operations allow for copying, moving, or deleting multiple entities at once, with options to copy related entities or overwrite existing ones.\u003c/p\u003e\n"],["\u003cp\u003eCustom entity type names must be unique for each agent and follow specific naming conventions, although reference and synonym values have no such limitations.\u003c/p\u003e\n"]]],[],null,["# Custom entities\n\nYou can create custom entities for matching data specific to your agent.\nFor example, you could define a `vegetable` entity type\nthat can match the types of vegetables\navailable for purchase with a grocery store agent.\n| **Note:** When building your agent, it's best to define your entities prior to adding [training phrases](/dialogflow/docs/intents-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.\n\nWhere to find this data\n-----------------------\n\nWhen building an agent,\nit is most common to use the\nDialogflow ES console ([visit documentation](/dialogflow/docs/console), [open console](https://dialogflow.cloud.google.com)).\nThe instructions below focus on using the console.\nTo access custom entity data:\n\n1. Go to the [Dialogflow ES console](https://dialogflow.cloud.google.com).\n2. Select an agent.\n3. Select **Entities** in the left sidebar menu.\n4. Select the **Custom** tab for custom entities.\n\nIf you are building an agent using the API instead of the console, see the\n[EntityTypes reference](/dialogflow/docs/reference/common-types#entitytypes).\nThe API field names are similar to the console field names.\nThe instructions below highlight any important differences between the console and the API.\n\nCreate custom entities\n----------------------\n\nTo create a custom [map entity](/dialogflow/docs/entities-options#map):\n\n1. Click **Create entity**.\n2. Enter a name for the entity.\n3. Note that **Define synonyms** is already checked.\n4. Click the first row and provide a reference value in the left column.\n5. Click the next column or press **Enter** and provide synonyms.\n6. Continue adding rows for other entity entries.\n7. Click **Save**.\n\nBatch operations\n----------------\n\nYou can move, copy, or delete multiple entities using batch operations:\n\n- **Copy**: Copies selected entities to the target agent.\n- **Move**: Moves selected entities to the target agent.\n- **Delete**: Permanently deletes the selected entities. This cannot be undone.\n\nThe following additional options are prompted for copy and move operations:\n\n- **Copy related entities** : Moves or copies entities used in [composite entities](/dialogflow/docs/entities-options#comp).\n- **Overwrite entities**: Overwrites entities with the same name.\n\nTo copy, move, or delete multiple entities:\n\n1. Hover you mouse over the list and select one or more entities. This reveals the batch options.\n2. Choose the desired action.\n3. Select the desired options in the dialog.\n4. Click **Start**.\n\nLimitations\n-----------\n\nThe following limitations apply:\n\n- Custom entity type names are unique for each agent. Entity type 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."]]