Note: Vertex AI Search is being renamed to Agent Search. We are in the process of updating content to reflect the new branding.

Purge data from a data store

This page describes how to purge all of the data in a structured or unstructured data store.

You purge the data in a data store if you want to completely delete the contents of the data store before re-importing fresh data. Purging a data store deletes only the data in the data store, leaving your app, schema, and configurations intact.

For how to delete a data store, see Delete a datastore.

Website data stores

Purging is not an option for website data stores because you can remove websites from website data stores as needed.

Purge data

To purge data from a data store, do the following:

Console

To use the Google Cloud console to purge the data from a branch of a structured, unstructured, or healthcare data store, follow these steps:

In the Google Cloud console, go to the AI Applications page.

AI Applications
In the navigation menu, click Data Stores.
In the Name column, click the data store that you want to purge.
In the Documents tab, click Purge data.
Read the warning in the Confirm purge data dialog. If you want to continue, enter the name of your data store, and then click Confirm. Purging data is a long-running operation. For more information, see Monitor long-running operations.
Click the Activity tab to monitor the progress of the purge operation.

REST

To use the command line to purge the data from a branch of a structured or unstructured data store, follow these steps:

Find your data store ID. If you already have your data store ID, skip to the next step.
1. In the Google Cloud console, go to the AI Applications page and in the navigation menu, click Data Stores.
  
  Go to the Data Stores page
2. Click the name of your data store.
3. On the Data page for your data store, get the data store ID.
Call the documents.purge method.
```
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/branches/0/documents:purge" \
-d '{
  "filter": "*",
  "force": FORCE
}'
```
Replace the following:
- PROJECT_ID: Google Cloud project.
- DATA_STORE_ID: the ID of the Agent Search data store..
- FORCE: a boolean value that specifies whether to delete data from the branch of the data store.
  - If true, deletes all data from the branch
  - If false, deletes no data and returns a list of documents in the branch.
  - If force is omitted, the default is false.
Optional: Make note of the name value returned by the documents.purge method and follow the instructions in Get details about a long-running operation to see when the purge operation is complete.

C#

For more information, see the Agent Search C# API reference documentation.

To authenticate to Agent Search, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

using Google.Cloud.DiscoveryEngine.V1;
using Google.LongRunning;

public sealed