Method: projects.locations.dataStores.patch

更新单个 DataStore 的参数。

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

HTTP 请求

PATCH https://vectorsearch.googleapis.com/v1beta/{dataStore.name}

路径参数

参数
dataStore.name

string

标识符。DataStore 的完全限定资源名称。

格式：projects/{project}/locations/{location}/dataStores/{dataStoreId}

查询参数

参数
updateMask

string (FieldMask format)

可选。字段掩码用于指定更新要在 DataStore 资源中覆盖的字段。updateMask 中指定的字段与资源相关，而不是与完整请求相关。如果字段在掩码中，则会被覆盖。 如果路径指定了消息，则会替换整个消息：请求中省略的子字段会被清除，并在 processingConfig 下恢复为默认值。

如果用户未提供掩码，则请求中设为非默认值的每个字段都会被覆盖。发送的空消息（例如 layoutParsingConfig: {}）和设置为默认值的字段（例如 false）不会应用；请改为在掩码中为其命名。

以下字段支持更新：displayName、description、labels、processingConfig 和 documentMetadataSchema。documentMetadataSchema 必须作为一个整体进行更新（掩码路径为 documentMetadataSchema），并且只能通过添加属性进行更新：无法移除或更改现有属性。

如果 updateMask 中提供了 *，系统将执行完全替换。

这是完全限定字段名称的逗号分隔列表。示例："user.displayName,photo"。
requestId

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了，服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

请求正文

请求正文包含一个 DataStore 实例。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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