Method: projects.locations.corpora.indexes.patch

更新语料库下的索引。用户可以使用不同的 updateMask 值执行仅限元数据的更新或触发完全重建索引。

HTTP 请求

PATCH https://visionai.googleapis.com/v1/{index.name=projects/*/locations/*/corpora/*/indexes/*}

网址采用 gRPC 转码语法。

路径参数

参数
index.name

string

仅限输出。索引资源的资源名称。格式:projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

查询参数

参数
updateMask

string (FieldMask format)

必需。字段掩码用于指定更新将在 Index 资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果资源的字段在掩码中,则会被覆盖。字段掩码不得为空。如果掩码为“*”,则会触发对索引的完整更新,以及对索引数据的完整重建。

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

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

IAM 权限

需要拥有 name 资源的以下 IAM 权限:

  • visionai.indexes.update

如需了解详情,请参阅 IAM 文档