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

Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

生成自定义文档分类器。

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	文档智能服务终结点。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
classifierId	True	string	唯一的文档分类器名称。
docTypes	True	<string,  ClassifierDocumentTypeDetails>	要分类的文档类型的列表。
baseClassifierId		string	基 classifierId 在上面训练分类器。
description		string	文档分类器说明。

响应

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

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

示例

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

定义

名称	说明
AzureBlobContentSource	Azure Blob 存储内容。
AzureBlobFileListContentSource	Azure Blob 存储 中的文件列表。
BuildDocumentClassifierRequest	请求正文以生成新的自定义文档分类器。
ClassifierDocumentTypeDetails	分类器文档类型信息。
ContentSourceKind	内容源的类型。
Error	错误对象。
ErrorResponse	错误响应对象。
InnerError	包含有关错误的更具体信息的对象。

AzureBlobContentSource

Azure Blob 存储内容。

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

AzureBlobFileListContentSource

Azure Blob 存储 中的文件列表。

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

BuildDocumentClassifierRequest

请求正文以生成新的自定义文档分类器。

名称	类型	说明
baseClassifierId	string	基 classifierId 在上面训练分类器。
classifierId	string	唯一的文档分类器名称。
description	string	文档分类器说明。
docTypes	<string,  ClassifierDocumentTypeDetails>	要分类的文档类型的列表。

ClassifierDocumentTypeDetails

分类器文档类型信息。

名称	类型	说明
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob 存储指定分类器文档类型的训练数据的文件列表。 必须指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource	Azure Blob 存储包含分类器文档类型的训练数据的位置。 必须指定 azureBlobSource 或 azureBlobFileListSource。
sourceKind	ContentSourceKind	训练数据源的类型。

ContentSourceKind

内容源的类型。

名称	类型	说明
azureBlob	string	Azure Blob 存储容器内路径中的文件。
azureBlobFileList	string	指定Azure Blob 存储容器中的单个文件的文件列表。
base64	string	通过 Base64 编码表示的内容。
url	string	特定 URL 处的内容。

Error

错误对象。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
details	Error[]	有关导致此项报告错误的特定错误的详细信息数组。
innererror	InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

ErrorResponse

错误响应对象。

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

InnerError

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

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
innererror	InnerError	内部错误。
message	string	错误的用户可读表示形式。