SynonymType

  • SynonymType matches text based on a set of synonyms.

  • It includes fields for match type, accepting unknown values, and a map of synonym entities.

  • An Entity represents a single entry within the SynonymType, with optional display details and a list of synonyms.

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.