Method: projects.locations.agent.entityTypes.entities.batchUpdate

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

HTTP request

POST https://{endpoint}/v2/{parent=projects/*/locations/*/agent/entityTypes/*}/entities:batchUpdate

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the entity type to update or create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

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

  • dialogflow.entityTypes.batchUpdateEntities

Request body

The request body contains data with the following structure:

JSON representation 
{
  "entities": [
    {
      object (Entity)
    }
  ],
  "languageCode": string,
  "updateMask": string
}
Fields
entities[]

object (Entity)

Required. The entities to update or create.
languageCode

string

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
updateMask

string (FieldMask format)

Optional. The mask to control which fields get updated.

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

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.