BatchUpdateEntityTypesResponse

The response message for EntityTypes.BatchUpdateEntityTypes.

JSON representation
{
  "entityTypes": [
    {
      object(EntityType)
    }
  ]
}
Fields
entityTypes[]

object(EntityType)

The collection of updated or created entity types.

EntityType

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.

JSON representation
{
  "name": string,
  "displayName": string,
  "kind": enum(Kind),
  "autoExpansionMode": enum(AutoExpansionMode),
  "entities": [
    {
      object(Entity)
    }
  ]
}
Fields
name

string

Required for all methods except create (create populates the name automatically. The unique identifier of the entity type. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

displayName

string

Required. The name of the entity.

kind

enum(Kind)

Required. Indicates the kind of entity type.

autoExpansionMode

enum(AutoExpansionMode)

Optional. Indicates whether the entity type can be automatically expanded.

entities[]

object(Entity)

Optional. The collection of entities associated with the entity type.

Entity

Optional. Represents an entity.

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

string

Required. For KIND_MAP entity types: A canonical name 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 synonyms. For KIND_LIST entity types this must contain exactly one synonym equal to value.