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

Miscellaneous - List Operations

参考

Service:: Azure AI Services

API Version:: 2023-07-31

Lists所有操作。

GET {endpoint}/formrecognizer/operations?api-version=2023-07-31

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string url	支持的认知服务终结点 (协议和主机名，例如： https://westus2.api.cognitive.microsoft.com) 。
api-version	query	True	string	请求的 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string	Azure 认知服务订阅的密钥。

响应

名称	类型	说明
200 OK	GetOperationsResponse	没问题。
Other Status Codes	ErrorResponse	遇到错误。

安全性

Ocp-Apim-Subscription-Key

Azure 认知服务订阅的密钥。

Type: apiKey
In: header

示例

Get Operations

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?api-version=2023-07-31

Sample Response

Status code:: 200

{
  "value": [
    {
      "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
      "apiVersion": "2023-07-31"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData"
}

定义

名称	说明
Error	错误信息。
ErrorResponse	错误响应对象。
GetOperationsResponse	列出操作响应对象。
InnerError	详细错误。
OperationKind	操作类型。
OperationStatus	操作状态。
OperationSummary	操作信息。

Error

错误信息。

名称	类型	说明
code	string	错误代码。
details	Error[]	详细错误列表。
innererror	InnerError	详细错误。
message	string	错误消息。
target	string	错误的目标。

ErrorResponse

错误响应对象。

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

GetOperationsResponse

列出操作响应对象。

名称	类型	说明
nextLink	string	链接到操作的下一页。
value	OperationSummary[]	操作列表。

InnerError

详细错误。

名称	类型	说明
code	string	错误代码。
innererror	InnerError	详细错误。
message	string	错误消息。

OperationKind

操作类型。

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

OperationStatus

操作状态。

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

OperationSummary

操作信息。

名称	类型	说明
apiVersion	string	用于创建此操作的 API 版本。
createdDateTime	string	创建操作时 (UTC) 日期和时间。
kind	OperationKind	操作类型。
lastUpdatedDateTime	string	上次更新状态时 (UTC) 日期和时间。
operationId	string	Operation ID
percentCompleted	integer	操作进度 (0-100) 。
resourceLocation	string	此操作所面向的资源的 URL。
status	OperationStatus	操作状态。
tags	object	与文档模型关联的键值标记属性的列表。

通过