Method: projects.agent.entityTypes.entities.batchDelete

Deletes entities in the specified entity type.

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

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

Required. The name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

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

  • dialogflow.entityTypes.batchDeleteEntities

Request body

The request body contains data with the following structure:

JSON representation
{
  "entityValues": [
    string
  ],
  "languageCode": string
}
Fields
entityValues[]

string

Required. The canonical values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<Project ID>.

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.

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.