Method: projects.agent.entityTypes.entities.batchUpdate

Updates entities in the specified entity type (replaces the existing collection of entries).

Operation <response: google.protobuf.Empty, metadata: google.protobuf.Struct>

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

Required. The name of the entity type to update the 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 collection of new entities to replace the existing entities.

languageCode

string

Optional. The language of entity synonyms defined in entities. If not specified, the agent's default language is used. More than a dozen 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 the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.