# RegularExpressionType

- [YAML representation](https://developers.google.com/assistant/actionssdk/reference/rest/Shared.Types/RegularExpressionType#SCHEMA_REPRESENTATION)
- [Entity](https://developers.google.com/assistant/actionssdk/reference/rest/Shared.Types/RegularExpressionType#Entity)
  - [YAML representation](https://developers.google.com/assistant/actionssdk/reference/rest/Shared.Types/RegularExpressionType#Entity.SCHEMA_REPRESENTATION)

Type that matches text by regular expressions. **This message is localizable.**

| YAML representation ||
|---|---|
| entities: string: object (https://developers.google.com/assistant/actionssdk/reference/rest/Shared.Types/RegularExpressionType#Entity) |

| Fields ||
|---|---|
| `entities` | ``map (key: string, value: object (`https://developers.google.com/assistant/actionssdk/reference/rest/Shared.Types/RegularExpressionType#Entity`))`` Required. Named map of entities which each contain Regex strings. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |

## Entity

Represents an entity object that contains the regular expression that is used for comparison.

| YAML representation ||
|---|---|
| ``` display: object (`https://developers.google.com/assistant/actionssdk/reference/rest/Shared.Types/EntityDisplay`) regularExpressions: - string ``` |

| Fields ||
|---|---|
| `display` | ``object (`https://developers.google.com/assistant/actionssdk/reference/rest/Shared.Types/EntityDisplay`)`` Optional. Elements that will be displayed on the canvas once an entity is extracted from a query. Only relevant for canvas enabled apps. |
| `regularExpressions[]` | `string` Required. Uses RE2 regex syntax (See <https://github.com/google/re2/wiki/Syntax> for more details) |