Method: projects.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.

Operation <response: google.protobuf.Empty>

HTTP request

POST https://dialogflow.googleapis.com/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchUpdate

The URL uses 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 Google 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 of entity synonyms defined in entities. 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.

updateMask

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".

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.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Dialogflow Documentation
Need help? Visit our support page.