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

Document Classifiers - Classify Document

服务:

Azure AI Services

API 版本:

2024-11-30

使用文档分类器对文档进行分类。

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30

具有可选参数:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType={stringIndexType}&split={split}&pages={pages}

URI 参数

名称	在	必需	类型	说明
classifierId	path	True	string	唯一的文档分类器名称。 正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	文档智能服务终结点。
api-version	query	True	string	用于此操作的 API 版本。
pages	query		string	要分析的基于 1 的页码。 前任。 "1-3,5,7-9" 正则表达式模式: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	文档拆分模式。
stringIndexType	query		StringIndexType	用于计算字符串偏移量和长度的方法。

请求正文

名称	类型	说明
base64Source	string	要分类的文档的 Base64 编码。 必须指定 urlSource 或 base64Source。
urlSource	string	要分类的文档 URL。 必须指定 urlSource 或 base64Source。

响应

名称	类型	说明
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

示例

Classify Document from Url

示例请求

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType=textElements

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

示例响应

状态代码:

202

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

定义

名称	说明
ClassifyDocumentRequest	文档分类参数。
DocumentIntelligenceError	错误对象。
DocumentIntelligenceErrorResponse	错误响应对象。
DocumentIntelligenceInnerError	包含有关错误的更具体信息的对象。
SplitMode	文件拆分行为。
StringIndexType	用于计算字符串偏移量和长度的方法。

ClassifyDocumentRequest

文档分类参数。

名称	类型	说明
base64Source	string	要分类的文档的 Base64 编码。 必须指定 urlSource 或 base64Source。
urlSource	string	要分类的文档 URL。 必须指定 urlSource 或 base64Source。

DocumentIntelligenceError

错误对象。

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

DocumentIntelligenceErrorResponse

错误响应对象。

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

DocumentIntelligenceInnerError

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

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

SplitMode

文件拆分行为。

名称	类型	说明
auto	string	自动将文件拆分为文档。
none	string	将整个文件视为单个文档。
perPage	string	将文件中的每一页视为单独的文档。

StringIndexType

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

名称	类型	说明
textElements	string	由 Unicode 8.0.0 定义的用户感知显示字符或 grapheme 群集。
unicodeCodePoint	string	由单个 unicode 代码点表示的字符单元。 由 Python 3 使用。
utf16CodeUnit	string	由 16 位 Unicode 代码单元表示的字符单元。 由 JavaScript、Java 和 .NET 使用。