Method: projects.agent.entityTypes.batchUpdate

Updates/Creates multiple entity types in the specified agent.

Operation <response: BatchUpdateEntityTypesResponse>

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The name of the agent to update or create entity types in. Format: projects/<Project ID>/agent.

Authorization requires the following Google IAM permission on the specified resource parent:

  • dialogflow.entityTypes.batchUpdate

Request body

The request body contains data with the following structure:

JSON representation
  "languageCode": string,
  "updateMask": string,

  // Union field entity_type_batch can be only one of the following:
  "entityTypeBatchUri": string,
  "entityTypeBatchInline": {
    object (EntityTypeBatch)
  // End of list of possible types for union field entity_type_batch.


Optional. The language of entity synonyms defined in entityTypes. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.


string (FieldMask format)

Optional. The mask to control which fields get updated.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Union field entity_type_batch. The source of the entity type batch.

For each entity type in the batch:

  • If name is specified, we update an existing entity type.
  • If name is not specified, we create a new entity type. entity_type_batch can be only one of the following:


The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://".


object (EntityTypeBatch)

The collection of entity types to update or create.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.


This message is a wrapper around a collection of entity types.

JSON representation
  "entityTypes": [
      object (EntityType)

object (EntityType)

A collection of entity types.

Try it!

Was deze pagina nuttig? Laat ons weten hoe goed we u hebben geholpen:

Feedback verzenden over...

Hulp nodig? Ga naar onze ondersteuningspagina.