System entities

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". You can see the full list of system entities in the System entity reference.

For most applications, the values provided by system entities 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. The System entity reference lists the system entities that can be extended.

Extend a system entity

To extend a system entity:

Console

  1. Use the system entity in one of your parameters.
  2. Select the Manage tab.
  3. Click Entity Types.
  4. Select the System tab for system entities.
  5. 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.
  6. You can select an extendable entity and update the extended values.
  7. Provide entity entries using the values you want to extend the entity with.

Screenshot of system entities tab

API

Creating system entity extensions is similar to how you create custom 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.