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

• HTTP 要求
• 路徑參數
• 查詢參數
• 要求主體
• 回應主體
• 授權範圍
• IAM 權限

取得 Document 的剖析版面配置資訊。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/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 說明文件。