Method: projects.locations.dataStores.purgeDocuments

Initiates a Long-Running Operation to purge Documents from a DataStore.

dataStores.purgeDocuments, dataStores.importDocuments and dataStores.patch run one at a time per DataStore. While one runs, one more can wait; any further request fails with ABORTED until the running operation finishes.

HTTP request

POST https://vectorsearch.googleapis.com/v1beta/{name}:purgeDocuments

Path parameters

Parameters

Parameters
`name`	`string` Required. The resource name of the DataStore to purge Documents from. Format: `projects/{project}/locations/{location}/dataStores/{dataStore}`.

name

string

Required. The resource name of the DataStore to purge Documents from. Format: projects/{project}/locations/{location}/dataStores/{dataStore}.

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "purgeOutputConfig": { object (`PurgeOutputConfig`) }, "force": boolean, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "gcsSource": { object (`GcsSource`) } // End of mutually exclusive fields. }

{
  "purgeOutputConfig": {
    object (PurgeOutputConfig)
  },
  "force": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsSource)
  }
  // End of mutually exclusive fields.
}

Fields
`purgeOutputConfig`	`object (PurgeOutputConfig)` Optional. Configuration of destination for purge documents output.
`force`	`boolean` Optional. Actually performs the purge. If `force` is set to `false`, return the expected purge count without deleting any Documents.
The Documents to purge, given by their Document IDs. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
`gcsSource`	`object (GcsSource)` Cloud Storage files that list the Documents to purge, one Document ID per line. Each line holds only the ID, not the full resource name. Each URI must name a single file: patterns and folders are not supported. A line that isn't a valid Document ID is reported as an error, and a file with no valid ID fails the purge. An ID that names no Document is skipped, and counted in `ignoredCount` in the operation's metadata. Each file can list at most 100,000 IDs.
End of mutually exclusive fields.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

PurgeOutputConfig

Configuration of destination for Purge related output.

JSON representation
{ "errorGcsPrefix": string }

Fields

Fields
`errorGcsPrefix`	`string` Optional. Cloud Storage prefix for purge errors. The prefix must not contain any objects. Purge errors will be written to sharded files under this prefix, one per line, as a JSON-encoded `google.rpc.Status` message.

errorGcsPrefix