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

Document Classifiers - List Classifiers

服务:

Azure AI Services

API 版本:

2024-11-30

列出所有文档分类器。

GET {endpoint}/documentintelligence/documentClassifiers?api-version=2024-11-30

URI 参数

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

请求头

名称	必需	类型	说明
x-ms-client-request-id		string uuid	请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称	类型	说明
200 OK	PagedDocumentClassifierDetails	请求已成功。 标头 x-ms-client-request-id: string
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

示例

Get Document Classifiers

示例请求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?api-version=2024-11-30

示例响应

状态代码:

200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "docTypes": {
        "formA": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formADocs/"
          }
        },
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        }
      }
    },
    {
      "classifierId": "classifier2",
      "description": "Classifier2 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "docTypes": {
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        },
        "formC": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formCDocs/"
          }
        }
      }
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?nextLink=nextLinkData"
}

定义

名称	说明
AzureBlobContentSource	Azure Blob 存储内容。
AzureBlobFileListContentSource	Azure Blob 存储中的文件列表。
ClassifierDocumentTypeDetails	分类器文档类型信息。
ContentSourceKind	内容类型。
DocumentClassifierDetails	文档分类器信息。
DocumentIntelligenceError	错误对象。
DocumentIntelligenceErrorResponse	错误响应对象。
DocumentIntelligenceInnerError	包含有关错误的更具体信息的对象。
DocumentIntelligenceWarning	错误对象。
PagedDocumentClassifierDetails	DocumentClassifierDetails 项的分页集合

AzureBlobContentSource

Azure Blob 存储内容。

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

AzureBlobFileListContentSource

Azure Blob 存储中的文件列表。

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

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 上的内容。

DocumentClassifierDetails

文档分类器信息。

名称	类型	说明
apiVersion	string	用于创建此文档分类器的 API 版本。
baseClassifierId	string	基于其训练分类器的基 classifierId。
classifierId	string	唯一的文档分类器名称。
createdDateTime	string	创建文档分类器的日期和时间（UTC）。
description	string	文档分类器说明。
docTypes	<string,  ClassifierDocumentTypeDetails>	要对其进行分类的文档类型列表。
expirationDateTime	string	文档分类器到期的日期和时间（UTC）。
modifiedDateTime	string	上次修改文档模型的日期和时间（UTC）。
warnings	DocumentIntelligenceWarning[]	生成分类器时遇到的警告列表。

DocumentIntelligenceError

错误对象。

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

DocumentIntelligenceErrorResponse

错误响应对象。

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

DocumentIntelligenceInnerError

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

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

DocumentIntelligenceWarning

错误对象。

名称	类型	说明
code	string	服务器定义的警告代码集之一。
message	string	警告的可读表示形式。
target	string	错误的目标。

PagedDocumentClassifierDetails

DocumentClassifierDetails 项的分页集合

名称	类型	说明
nextLink	string	指向下一页项的链接
value	DocumentClassifierDetails[]	此页面上的 DocumentClassifierDetails 项