你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Document Models - Analyze Batch Documents

参考

服务:: Azure AI Services

API 版本:: 2024-11-30

使用文档模型分析批处理文档。

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-11-30

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string uri	文档智能服务终结点。
modelId	path	True	string	唯一的文档模型名称。正则表达式模式: `^[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" 正则表达式模式: `^(\d+(-\d+)?)(,\s(\d+(-\d+)?))$`
queryFields	query		string[]	要提取的其他字段的列表。前任。 “NumberOfGuests，StoreNumber”
stringIndexType	query		StringIndexType	用于计算字符串偏移量和长度的方法。

请求正文

名称	必需	类型	说明
resultContainerUrl	True	string	将存储分析结果文件的 Azure Blob 存储容器 URL。
azureBlobFileListSource		AzureBlobFileListContentSource	指定批处理文档的 Azure Blob 存储文件列表。必须指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource		AzureBlobContentSource	包含批处理文档的 Azure Blob 存储位置。必须指定 azureBlobSource 或 azureBlobFileListSource。
overwriteExisting		boolean	覆盖现有的分析结果文件？
resultPrefix		string	结果文件的 Blob 名称前缀。

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。标头 Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	意外的错误响应。

名称

类型

说明

202 Accepted

已接受请求进行处理，但尚未完成处理。

标头

Operation-Location: string
Retry-After: integer

Other Status Codes

DocumentIntelligenceErrorResponse

意外的错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Analyze Batch Documents

示例请求

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyzeBatch?api-version=2024-11-30&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

定义

名称	说明
AnalyzeBatchDocumentsRequest	批处理文档分析参数。
AnalyzeOutputOption	在分析期间要生成的其他输出。
AzureBlobContentSource	Azure Blob 存储内容。
AzureBlobFileListContentSource	Azure Blob 存储中的文件列表。
DocumentAnalysisFeature	要启用的文档分析功能。
DocumentContentFormat	分析结果中内容的格式。
DocumentIntelligenceError	错误对象。
DocumentIntelligenceErrorResponse	错误响应对象。
DocumentIntelligenceInnerError	包含有关错误的更具体信息的对象。
StringIndexType	用于计算字符串偏移量和长度的方法。

AnalyzeBatchDocumentsRequest

批处理文档分析参数。

名称	类型	默认值	说明
azureBlobFileListSource	AzureBlobFileListContentSource		指定批处理文档的 Azure Blob 存储文件列表。必须指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource		包含批处理文档的 Azure Blob 存储位置。必须指定 azureBlobSource 或 azureBlobFileListSource。
overwriteExisting	boolean	False	覆盖现有的分析结果文件？
resultContainerUrl	string		将存储分析结果文件的 Azure Blob 存储容器 URL。
resultPrefix	string		结果文件的 Blob 名称前缀。

AnalyzeOutputOption

在分析期间要生成的其他输出。

名称	类型	说明
figures	string	生成检测到的图形的裁剪图像。
pdf	string	生成可搜索的 PDF 输出。

AzureBlobContentSource

Azure Blob 存储内容。

名称	类型	说明
containerUrl	string	Azure Blob 存储容器 URL。
prefix	string	Blob 名称前缀。

AzureBlobFileListContentSource

Azure Blob 存储中的文件列表。

名称	类型	说明
containerUrl	string	Azure Blob 存储容器 URL。
fileList	string	指定文档子集的容器中的 JSONL 文件的路径。

DocumentAnalysisFeature

要启用的文档分析功能。

名称	类型	说明
barcodes	string	启用文档中条形码检测。
formulas	string	启用文档中数学表达式的检测。
keyValuePairs	string	启用文档中常规键值对（窗体字段）的检测。
languages	string	启用文本内容语言检测。
ocrHighResolution	string	以更高的分辨率执行 OCR 以处理带有精细打印的文档。
queryFields	string	通过 queryFields 查询参数启用其他字段的提取。
styleFont	string	启用各种字体样式的识别。

DocumentContentFormat

分析结果中内容的格式。

名称	类型	说明
markdown	string	带有节标题、表格等的文档内容的 Markdown 表示形式。
text	string	不带任何格式的文档内容的纯文本表示形式。

DocumentIntelligenceError

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	DocumentIntelligenceError[]	导致此报告错误的特定错误的详细信息数组。
innererror	DocumentIntelligenceInnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

DocumentIntelligenceErrorResponse

错误响应对象。

名称	类型	说明
error	DocumentIntelligenceError	错误信息。

DocumentIntelligenceInnerError

包含有关错误的更具体信息的对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	DocumentIntelligenceInnerError	内部错误。
message	string	错误的人工可读表示形式。

StringIndexType

用于计算字符串偏移量和长度的方法。

名称	类型	说明
textElements	string	由 Unicode 8.0.0 定义的用户感知显示字符或 grapheme 群集。
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

DocumentAnalysisFeature

DocumentContentFormat

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

StringIndexType

其他资源