Document Models - Analyze Document

服務:

Azure AI Services

API 版本:

2024-11-30

使用檔模型分析檔。

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30

含選擇性參數:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	Document Intelligence 服務端點。
modelId	path	True	string	唯一的檔模型名稱。 Regex 模式: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	要用於這項作業的 API 版本。
features	query		DocumentAnalysisFeature[]	選擇性分析功能的清單。
locale	query		string	文字辨識和檔分析的地區設定提示。 值只能包含語言代碼 （例如 “en”、“fr”） 或BCP 47語言標記 （例如 “en-US]。
output	query		AnalyzeOutputOption[]	在分析期間產生的其他輸出。
outputContentFormat	query		DocumentContentFormat	分析結果最上層內容的格式。
pages	query		string	要分析的頁碼為 1。 前任。 "1-3,5,7-9" Regex 模式: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	要擷取的其他欄位清單。 前任。 “NumberOfGuests，StoreNumber”
stringIndexType	query		StringIndexType	用來計算字串位移和長度的方法。

要求本文

名稱	類型	Description
base64Source	string	要分析的檔Base64編碼。 必須指定urlSource或base64Source。
urlSource	string	要分析的檔URL。 必須指定urlSource或base64Source。

回應

名稱	類型	Description
202 Accepted		要求已接受進行處理，但尚未完成處理。 標題 Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	未預期的錯誤回應。

安全性

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

範例

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

範例要求

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

範例回覆

狀態碼:

202

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

Analyze Document from Url

範例要求

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

範例回覆

狀態碼:

202

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

定義

名稱	Description
AnalyzeDocumentRequest	檔分析參數。
AnalyzeOutputOption	在分析期間產生的其他輸出。
DocumentAnalysisFeature	要啟用的檔分析功能。
DocumentContentFormat	分析結果中的內容格式。
DocumentIntelligenceError	error 物件。
DocumentIntelligenceErrorResponse	錯誤回應物件。
DocumentIntelligenceInnerError	物件，包含有關錯誤的更特定資訊。
StringIndexType	用來計算字串位移和長度的方法。

AnalyzeDocumentRequest

檔分析參數。

名稱	類型	Description
base64Source	string	要分析的檔Base64編碼。 必須指定urlSource或base64Source。
urlSource	string	要分析的檔URL。 必須指定urlSource或base64Source。

AnalyzeOutputOption

在分析期間產生的其他輸出。

名稱	類型	Description
figures	string	產生已偵測到之數位的裁剪影像。
pdf	string	產生可搜尋的 PDF 輸出。

DocumentAnalysisFeature

要啟用的檔分析功能。

名稱	類型	Description
barcodes	string	啟用文件中條碼的偵測。
formulas	string	啟用檔中數學表達式的偵測。
keyValuePairs	string	啟用檔中一般索引鍵值組（表單域）的偵測。
languages	string	啟用文字內容語言的偵測。
ocrHighResolution	string	以更高的解析度執行 OCR，以處理具有精細列印的檔。
queryFields	string	透過 queryFields 查詢參數啟用其他欄位的擷取。
styleFont	string	啟用各種字型樣式的辨識。

DocumentContentFormat

分析結果中的內容格式。

名稱	類型	Description
markdown	string	具有區段標題、表格等的文件內容的 Markdown 表示法。
text	string	檔內容的純文本表示，沒有任何格式設定。

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	錯誤的人類可讀取表示法。

StringIndexType

用來計算字串位移和長度的方法。

名稱	類型	Description
textElements	string	使用者感知的顯示字元或 grapheme 叢集，如 Unicode 8.0.0 所定義。
unicodeCodePoint	string	以單一 Unicode 字碼點表示的字元單位。 由 Python 3 使用。
utf16CodeUnit	string	以16位Unicode字碼單位表示的字元單位。 由 JavaScript、Java 和 .NET 使用。