Method: projects.locations.dataStores.purgeDocuments

启动一项长时间运行的操作，以从 DataStore 中清除文档。

dataStores.purgeDocuments、dataStores.importDocuments 和 dataStores.patch 每次针对一个数据存储区运行。当一个操作运行时，另一个操作可以等待；在运行的操作完成之前，任何进一步的请求都会失败并显示 ABORTED。

HTTP 请求

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

路径参数

参数
name

string

必需。要从中完全清除文档的数据存储区的资源名称。格式：projects/{project}/locations/{location}/dataStores/{dataStore}。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "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

可选。实际执行完全清除操作。如果 force 设置为 false，则返回预期的完全清除计数，但不删除任何文档。
要清除的文档，由其文档 ID 指定。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
gcsSource

object (GcsSource)

列出要清除的文档的 Cloud Storage 文件，每行一个文档 ID。每行仅包含 ID，不包含完整资源名称。每个 URI 都必须指定单个文件：不支持模式和文件夹。

如果某一行不是有效的文档 ID，系统会报告错误；如果文件不包含有效 ID，则无法清除。系统会跳过未命名任何文档的 ID，并在操作元数据的 ignoredCount 中进行统计。每个文件最多可列出 100,000 个 ID。
互斥字段结束。

响应正文

如果成功，则响应正文包含一个 Operation 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

PurgeOutputConfig

清除操作相关输出的目标位置配置。

JSON 表示法 
{
  "errorGcsPrefix": string
}
字段
errorGcsPrefix

string

可选。用于清除错误的 Cloud Storage 前缀。前缀不得包含任何对象。清除操作的错误信息将以 JSON 编码的 google.rpc.Status 消息格式写入此前缀下的分片文件中，每行记录一条错误。