This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.

Changes in GA:

Name: Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
All changes: To see what else changed between preview and GA, see Switch from Discovery for Media to media recommendations in the Vertex AI Search documentation.

Method: projects.locations.collections.dataStores.branches.documents.delete

HTTP request
Path parameters
Request body
Response body
Authorization scopes
IAM Permissions
Try it!

Deletes a Document.

HTTP request

DELETE https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. Full resource name of `Document`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the `Document`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `Document` to delete does not exist, a `NOT_FOUND` error is returned.

name

string

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Document to delete does not exist, a NOT_FOUND error is returned.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

discoveryengine.documents.delete

For more information, see the IAM documentation.