Document Models - Get Analyze Result Pdf

服務:

Azure AI Services

API 版本:

2024-11-30

從檔分析取得產生的可搜尋 PDF 輸出。

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}/pdf?api-version=2024-11-30

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	Document Intelligence 服務端點。
modelId	path	True	string	唯一的檔模型名稱。 Regex 模式: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
resultId	path	True	string uuid	分析作業結果標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	file	要求已成功。 Media Types: "application/pdf", "application/json"
Other Status Codes	DocumentIntelligenceErrorResponse	未預期的錯誤回應。 Media Types: "application/pdf", "application/json"

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Get Analyze Document Result PDF

範例要求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034/pdf?api-version=2024-11-30

範例回覆

狀態碼:

200

"{pdfBinary}"

定義

名稱	Description
DocumentIntelligenceError	error 物件。
DocumentIntelligenceErrorResponse	錯誤回應物件。
DocumentIntelligenceInnerError	物件，包含有關錯誤的更特定資訊。

DocumentIntelligenceError

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	DocumentIntelligenceError[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	DocumentIntelligenceInnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

DocumentIntelligenceErrorResponse

錯誤回應物件。

名稱	類型	Description
error	DocumentIntelligenceError	錯誤資訊。

DocumentIntelligenceInnerError

物件，包含有關錯誤的更特定資訊。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	DocumentIntelligenceInnerError	內部錯誤。
message	string	錯誤的人類可讀取表示法。