Method: projects.locations.collections.dataStores.branches.documents.patch

更新 Document。

HTTP 请求

PATCH https://discoveryengine.googleapis.com/v1/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}

网址采用 gRPC 转码语法。

路径参数

参数
document.name

string

不可变。文档的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。

查询参数

参数
allowMissing

boolean

如果设置为 true 且未找到 Document，则系统会创建新的 Document。
updateMask

string (FieldMask format)

指示要更新所提供的导入“文档”中的哪些字段。如果未设置，则默认更新所有字段。

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

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

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

  • discoveryengine.documents.update

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