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

• HTTP 请求
• 路径参数
• 查询参数
• 请求正文
• 响应正文
• 授权范围
• IAM 权限

获取 Document 的已解析布局信息。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}:getProcessedDocument

网址采用 gRPC 转码语法。

路径参数

参数
name	string 必需。Document 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}。 如果调用方没有访问 Document 的权限（无论该 Document 是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 Document 不存在，则返回 NOT_FOUND 错误。

查询参数

参数
processedDocumentType	enum (ProcessedDocumentType) 必需。要返回的处理类型。
processedDocumentFormat	enum (ProcessedDocumentFormat) 输出应采用的格式。如果未指定，则默认为 JSON。
imageId	string 可选。指定 IMAGE_BYTES 的配置。

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

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

• discoveryengine.documents.get

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