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

Miscellaneous Operations - Get Document Classifier Build Operation

参考

服务:: Azure AI Services

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

获取操作信息。

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&api-version=2024-07-31-preview

URI 参数

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

请求头

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

响应

名称	类型	说明
200 OK	DocumentClassifierBuildOperationDetails	请求已成功。标头 x-ms-client-request-id: string
Other Status Codes	ErrorResponse	意外的错误响应。

名称

类型

说明

200 OK

DocumentClassifierBuildOperationDetails

请求已成功。

标头

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

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 Operation - Document Classifier Build

示例请求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierBuildOperation&api-version=2024-07-31-preview

示例响应

状态代码:: 200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentClassifierBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier",
  "result": {
    "classifierId": "myClassifier",
    "description": "Classifier description",
    "createdDateTime": "2022-07-30T00:00:00Z",
    "expirationDateTime": "2023-01-01T00:00:00Z",
    "apiVersion": "2024-07-31-preview",
    "docTypes": {
      "formA": {
        "azureBlobSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "prefix": "formADocs/"
        }
      },
      "formB": {
        "azureBlobFileListSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "fileList": "formB.jsonl"
        }
      }
    }
  }
}

定义

名称	说明
AzureBlobContentSource	Azure Blob 存储内容。
AzureBlobFileListContentSource	Azure Blob 存储中的文件列表。
ClassifierDocumentTypeDetails	分类器文档类型信息。
ContentSourceKind	内容类型。
DocumentClassifierBuildOperationDetails	获取操作响应对象。
DocumentClassifierDetails	文档分类器信息。
Error	错误对象。
ErrorResponse	错误响应对象。
InnerError	包含有关错误的更具体信息的对象。
OperationKind	操作的类型。
OperationStatus	操作状态。
Warning	错误对象。

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

DocumentClassifierBuildOperationDetails

获取操作响应对象。

名称	类型	说明
apiVersion	string	用于创建此操作的 API 版本。
createdDateTime	string	创建操作的日期和时间（UTC）。
error	Error	遇到错误。
kind	string: documentClassifierBuild	操作的类型。
lastUpdatedDateTime	string	上次更新状态的日期和时间（UTC）。
operationId	string	操作 ID
percentCompleted	integer	操作进度（0-100）。
resourceLocation	string	此操作面向的资源的 URL。
result	DocumentClassifierDetails	成功后的操作结果。
status	OperationStatus	操作状态。 notStarted、running、completed 或 failed
tags	object	与文档模型关联的键值标记属性的列表。

DocumentClassifierDetails

文档分类器信息。

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

Error

错误对象。

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

ErrorResponse

错误响应对象。

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

InnerError

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

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

OperationKind

操作的类型。

名称	类型	说明
documentClassifierBuild	string	生成新的自定义分类器模型。
documentClassifierCopyTo	string	将现有文档分类器复制到可能不同的资源、区域或订阅。
documentModelBuild	string	生成新的自定义文档模型。
documentModelCompose	string	从现有模型撰写新的自定义文档模型。
documentModelCopyTo	string	将现有文档模型复制到可能不同的资源、区域或订阅。

OperationStatus

操作状态。

名称	类型	说明
canceled	string	操作已被取消。
completed	string	操作已完成。
failed	string	操作失败。
notStarted	string	操作尚未启动。
running	string	操作正在进行中。
succeeded	string	操作已成功。

Warning

错误对象。

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

通过

Miscellaneous Operations - Get Document Classifier Build Operation

URI 参数

请求头

响应

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

作用域

示例

Get Operation - Document Classifier Build

示例请求

示例响应

定义

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

Error

ErrorResponse

InnerError

OperationKind

OperationStatus

Warning

其他资源