Document Models - Analyze Batch Documents

參考

服務:: Azure AI Services

API 版本:: 2024-07-31-preview

使用檔模型分析批次檔。

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-07-31-preview

含選擇性參數:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-07-31-preview&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		ContentFormat	分析結果最上層內容的格式。
pages	query		string	要分析的 1 頁碼清單。前任。 "1-3,5,7-9" Regex 模式: `^(\d+(-\d+)?)(,\s(\d+(-\d+)?))$`
queryFields	query		string[]	要擷取的其他欄位清單。前任。 “NumberOfGuests，StoreNumber”
stringIndexType	query		StringIndexType	用來計算字串位移和長度的方法。

要求本文

名稱	必要	類型	Description
resultContainerUrl	True	string	將儲存分析結果檔案的 Azure Blob 記憶體容器 URL。
azureBlobFileListSource		AzureBlobFileListContentSource	指定批次檔的 Azure Blob 記憶體檔案清單。必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource		AzureBlobContentSource	包含批次檔的 Azure Blob 記憶體位置。必須指定 azureBlobSource 或 azureBlobFileListSource。
overwriteExisting		boolean	覆寫現有的分析結果檔？
resultPrefix		string	結果檔案的 Blob 名稱前置詞。

回應

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

名稱

類型

Description

202 Accepted

要求已接受進行處理，但尚未完成處理。

標題

Operation-Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

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 Batch Documents

範例要求

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyzeBatch?api-version=2024-07-31-preview&pages=1-5&locale=en-US&stringIndexType=textElements

{
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "resultContainerUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer?mySasToken",
  "resultPrefix": "trainingDocsResult/",
  "overwriteExisting": true
}

範例回覆

狀態碼:: 202

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

定義

名稱	Description
AnalyzeBatchDocumentsRequest	批次檔分析參數。
AnalyzeOutputOption	在分析期間產生的其他輸出。
AzureBlobContentSource	Azure Blob 記憶體內容。
AzureBlobFileListContentSource	Azure Blob 記憶體中的檔案清單。
ContentFormat	分析結果中的內容格式。
DocumentAnalysisFeature	要啟用的檔分析功能。
Error	error 物件。
ErrorResponse	錯誤回應物件。
InnerError	物件，包含有關錯誤的更特定資訊。
StringIndexType	用來計算字串位移和長度的方法。

AnalyzeBatchDocumentsRequest

批次檔分析參數。

名稱	類型	預設值	Description
azureBlobFileListSource	AzureBlobFileListContentSource		指定批次檔的 Azure Blob 記憶體檔案清單。必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource		包含批次檔的 Azure Blob 記憶體位置。必須指定 azureBlobSource 或 azureBlobFileListSource。
overwriteExisting	boolean	False	覆寫現有的分析結果檔？
resultContainerUrl	string		將儲存分析結果檔案的 Azure Blob 記憶體容器 URL。
resultPrefix	string		結果檔案的 Blob 名稱前置詞。

AnalyzeOutputOption

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

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

AzureBlobContentSource

Azure Blob 記憶體內容。

名稱	類型	Description
containerUrl	string	Azure Blob 記憶體容器 URL。
prefix	string	Blob 名稱前置詞。

AzureBlobFileListContentSource

Azure Blob 記憶體中的檔案清單。

名稱	類型	Description
containerUrl	string	Azure Blob 記憶體容器 URL。
fileList	string	指定文件子集之容器內的 JSONL 檔案路徑。

ContentFormat

分析結果中的內容格式。

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

DocumentAnalysisFeature

要啟用的檔分析功能。

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

Error

error 物件。

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

ErrorResponse

錯誤回應物件。

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

InnerError

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

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

StringIndexType

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

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

共用方式為

Document Models - Analyze Batch Documents

URI 參數

要求本文

回應

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

範圍

範例

Analyze Batch Documents

範例要求

範例回覆

定義

AnalyzeBatchDocumentsRequest

AnalyzeOutputOption

AzureBlobContentSource

AzureBlobFileListContentSource

ContentFormat

DocumentAnalysisFeature

Error

ErrorResponse

InnerError

StringIndexType

其他資源