Method: projects.locations.agents.entityTypes.delete

Deletes the specified entity type.

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

HTTP request

DELETE https://{endpoint}/v3beta1/{name=projects/*/locations/*/agents/*/entityTypes/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the entity type to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

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

  • dialogflow.entityTypes.delete

Query parameters

Parameters
force

boolean

This field has no effect for entity type not being used. For entity types that are used by intents or pages:

  • If force is set to false, an error will be returned with message indicating the referencing resources.
  • If force is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

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.