Miscellaneous - List Operations

Ссылка

Служба:: Azure AI Services

Версия API:: 2022-08-31

Списки всех операций.

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Запрошенная версия API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	GetOperationsResponse	Все в порядке.
Other Status Codes	ErrorResponse	Ошибка.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

GetOperations

Образец запроса

HTTP

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "operationId": "{operationId}",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

Определения

Имя	Описание
ApiVersion	Версия API.
Error	Сведения об ошибке.
ErrorResponse	Объект ответа об ошибке.
GetOperationsResponse	Объект ответа Операций перечисления.
InnerError	Подробная ошибка.
OperationKind	Тип операции.
OperationStatus	Состояние операции.
OperationSummary	Сведения об операции.

ApiVersion

Версия API.

Имя	Тип	Описание
2022-08-31	string

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

Тип операции.

Имя	Тип	Описание
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	Список атрибутов тега "ключ—значение", связанных с моделью документа.

Поделиться через