System entity extension

Dialogflow provides many system entities to extract common types from end-user expressions. For example, the @sys.color type can be used to extract values like "red" or "blue". For most applications, the values provided by Dialogflow work well. However, your application may need to add additional values for system entities. For example, you may want to add "blue-green" to the list of values for @sys.color. Some system entities can be extended for this purpose. For the complete list of extendable system entities, see the system entities reference.

Where to find this data

When building an agent, it is most common to use the Dialogflow Console (visit documentation, open console). The instructions below focus on using the console. To access intent and entity data:

  1. Go to the Dialogflow Console.
  2. Select an agent.
  3. Select Intents or Entities in the left sidebar menu.

If you are building an agent using the API instead of the console, see the Intents reference and 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.

Extend a system entity while annotating a training phrase

From the intent page's training phrase section, you can extend a system entity while annotating a training phrase. If you manually annotate a training phrase part with an extendable system entity that does not include the selected value, you will be prompted to add this value to the system entity.

Extend a system entity from the entities page

From the entities page, you can extend a system entity by following these steps:

  1. Create an entity.
  2. Use the name of the system entity you want to extend. For example: sys.color.
  3. Provide entity entries using the values you want to extend the entity with.

If you are using the API to extend system entities, create system entity extensions similar to how you create developer entities. Provide the name of the system entity you wish to extend, and provide the values you want to extend it with. If you attempt to extend a system entity that is not extendable, you will receive an error.

View and update extended system entities

The top of the entities page has Custom and System tabs. Select the System tab, and the system entities currently used by your agent are listed. Entities shown in a grey font color are not extendable, and entities shown in a normal font color are extendable. You can select an extendable entity and update the extended values.

Screenshot of system entities tab

Was this page helpful? Let us know how we did:

Send feedback about...

Dialogflow Documentation
Need help? Visit our support page.