SynonymType
Stay organized with collections
Save and categorize content based on your preferences.
Type that matches text by set of synonyms.
| YAML representation |
matchType: enum (MatchType)
acceptUnknownValues: boolean
entities:
string: object (Entity) |
| Fields |
matchType |
enum (MatchType)
Optional. The match type for the synonym.
|
acceptUnknownValues |
boolean
Optional. When set to true this will match unknown words or phrases based on surrounding input and intent training data, such as items that might be added to a grocery list.
|
entities |
map (key: string, value: object (Entity))
Required. Named map of synonym entities. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
Entity
Represents a synonym entity field that contains the details of a single entry inside the type.
| YAML representation |
display:
object (EntityDisplay)
synonyms:
- string |
| Fields |
display |
object (EntityDisplay)
Optional. The entity display details.
|
synonyms[] |
string
Optional. The list of synonyms for the entity. This field is localizable.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThis content describes a type that matches text using synonyms, with options for match type and unknown value handling.\u003c/p\u003e\n"],["\u003cp\u003eIt includes entities, which are named maps of synonym entities with details like display and synonyms list.\u003c/p\u003e\n"],["\u003cp\u003eThe synonym type uses a YAML representation for defining its structure and properties.\u003c/p\u003e\n"],["\u003cp\u003eEntities within the synonym type can also have their own YAML representation and properties, including display and synonyms.\u003c/p\u003e\n"]]],[],null,["# SynonymType\n\n- [YAML representation](#SCHEMA_REPRESENTATION)\n- [Entity](#Entity)\n - [YAML representation](#Entity.SCHEMA_REPRESENTATION)\n\nType that matches text by set of synonyms.\n\n| YAML representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| matchType: enum (/assistant/actionssdk/reference/rest/Shared.Types/MatchType) acceptUnknownValues: boolean entities: string: object (/assistant/actionssdk/reference/rest/Shared.Types/SynonymType#Entity) |\n\n| Fields ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matchType` | `enum (`[MatchType](/assistant/actionssdk/reference/rest/Shared.Types/MatchType)`)` Optional. The match type for the synonym. |\n| `acceptUnknownValues` | `boolean` Optional. When set to true this will match unknown words or phrases based on surrounding input and intent training data, such as items that might be added to a grocery list. |\n| `entities` | `map (key: string, value: object (`[Entity](/assistant/actionssdk/reference/rest/Shared.Types/SynonymType#Entity)`))` Required. Named map of synonym entities. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n\nEntity\n------\n\nRepresents a synonym entity field that contains the details of a single entry inside the type.\n\n| YAML representation ||\n|--------------------------------------------------------------------------------------------------------------|---|\n| ``` display: object (/assistant/actionssdk/reference/rest/Shared.Types/EntityDisplay) synonyms: - string ``` |\n\n| Fields ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `display` | `object (`[EntityDisplay](/assistant/actionssdk/reference/rest/Shared.Types/EntityDisplay)`)` Optional. The entity display details. |\n| `synonyms[]` | `string` Optional. The list of synonyms for the entity. **This field is localizable.** |"]]
