Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details.

Entity

JSON representation

An entity entry for an associated entity type.

JSON representation
{ "value": string, "synonyms": [ string ] }

Fields

Fields
`value`	`string` Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For `KIND_MAP` entity types: A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: A string that can contain references to other entity types (with or without aliases).
`synonyms[]`	`string` Required. A collection of value synonyms. For example, if the entity type is vegetable, and `value` is scallions, a synonym could be green onions. For `KIND_LIST` entity types: This collection must contain exactly one synonym equal to `value`.

value

string

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

A canonical value to be used in place of synonyms.

For KIND_LIST entity types:

A string that can contain references to other entity types (with or without aliases).

synonyms[]

string

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

This collection must contain exactly one synonym equal to value.