Some entities need to match patterns rather than specific terms. For example, national identification numbers, IDs, license plates, and so on. With regexp entities, you can provide regular expressions for matching.
Where to find this data
- Go to the Dialogflow ES Console.
- Select an agent.
- Select Entities in the left sidebar menu.
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.
Compound regular expressions
Each regexp entity corresponds to a single pattern,
but you can provide multiple regular expressions if they all represent variations of a single pattern.
During agent training, all regular expressions of a single entity are combined
with the alternation operator (
|) to form one compound regular expression.
For example, if you provide the following regular expressions for a phone number:
The compound regular expression becomes:
The ordering of regular expressions matters. Each of the regular expressions in the compound regular expression are processed in order. Searching stops once a valid match is found. For example, for an end user expression of "Seattle":
Special handling for speech recognition
If your agent uses speech recognition (also known as audio input, speech-to-text, or STT), your regular expressions will need special handling when matching letters and numbers. A spoken end-user utterance is first processed by the speech recognizer before entities are matched. When an utterance contains a series of letters or numbers, the recognizer may pad each character with spaces. In addition, the recognizer may interpret digits in word form. For example, an end-user utterance of "My ID is 123" may be recognized as any of the following:
- "My ID is 123"
- "My ID is 1 2 3"
- "My ID is one two three"
To accommodate three digit numbers, you could use the following regular expressions:
\d \d \d
(zero|one|two|three|four|five|six|seven|eight|nine) (zero|one|two|three|four|five|six|seven|eight|nine) (zero|one|two|three|four|five|six|seven|eight|nine)
Create a regexp entity
To create a regexp entity:
- Open an existing entity or create a new one.
- Check Regexp entity.
- Enter one or more regular expressions in the entries table.
- Click Save.
If you are using the API to create or update entities,
KIND_REGEXP for the entity kind field.
The following limitations apply:
- Fuzzy matching cannot be enabled for regexp entities. These features are mutually exclusive.
- Each agent can have a maximum of 50 regexp entities.
- The compound regular expression for an entity has a maximum length of 1024 characters.