Miscellaneous Operations - Get Operation

Ссылка

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Возвращает сведения об операции.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&api-version=2024-02-29-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Конечная точка службы аналитики документов.
operationId	path	True	string	Operation ID
api-version	query	True	string	Версия API, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string uuid	Непрозрачный, глобально уникальный, созданный клиентом строковый идентификатор для запроса.

Ответы

Имя	Тип	Описание
200 OK	OperationDetails: DocumentClassifierBuildOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	Запрос выполнен успешно. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

OperationDetails:

DocumentClassifierBuildOperationDetails
DocumentModelBuildOperationDetails
DocumentModelComposeOperationDetails
DocumentModelCopyToOperationDetails

Запрос выполнен успешно.

Headers

x-ms-client-request-id: string

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

Примеры

Get Operation

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-02-29-preview"
  }
}

Определения

Имя	Описание
AzureBlobContentSource	содержимое Хранилище BLOB-объектов Azure.
AzureBlobFileListContentSource	Список файлов в Хранилище BLOB-объектов Azure.
ClassifierDocumentTypeDetails	Сведения о типе документа классификатора.
ContentSourceKind	Тип источника контента.
DocumentBuildMode	Режим сборки пользовательской модели документов.
DocumentClassifierBuildOperationDetails	Получение объекта ответа Operation.
DocumentClassifierDetails	Сведения о классификаторе документов.
DocumentFieldSchema	Описание семантической схемы поля с использованием синтаксиса стиля схемы JSON.
DocumentFieldType	Семантический тип данных значения поля.
DocumentModelBuildOperationDetails	Получение объекта ответа Operation.
DocumentModelComposeOperationDetails	Получение объекта ответа Operation.
DocumentModelCopyToOperationDetails	Получение объекта ответа Operation.
DocumentModelDetails	Сведения о модели документа.
DocumentTypeDetails	Сведения о типе документа.
Error	Объект ошибки.
ErrorResponse	Объект ответа об ошибке.
InnerError	Объект , содержащий более конкретные сведения об ошибке.
OperationKind	Тип операции.
OperationStatus	Состояние операции.
Warning	Объект ошибки.

AzureBlobContentSource

содержимое Хранилище BLOB-объектов Azure.

Имя	Тип	Описание
containerUrl	string	Хранилище BLOB-объектов Azure URL-адрес контейнера.
prefix	string	Префикс имени BLOB-объекта.

AzureBlobFileListContentSource

Список файлов в Хранилище BLOB-объектов Azure.

Имя	Тип	Описание
containerUrl	string	Хранилище BLOB-объектов Azure URL-адрес контейнера.
fileList	string	Путь к JSONL-файлу в контейнере с указанием подмножества документов.

ClassifierDocumentTypeDetails

Сведения о типе документа классификатора.

Имя	Тип	Описание
azureBlobFileListSource	AzureBlobFileListContentSource	Хранилище BLOB-объектов Azure список файлов, указывающий обучающие данные для типа документа классификатора. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Хранилище BLOB-объектов Azure расположение, содержащее обучающие данные для типа документа классификатора. Необходимо указать azureBlobSource или azureBlobFileListSource.
sourceKind	ContentSourceKind	Тип источника данных для обучения.

ContentSourceKind

Тип источника контента.

Имя	Тип	Описание
azureBlob	string	Файлы в пути в контейнере Хранилище BLOB-объектов Azure.
azureBlobFileList	string	Список файлов, указывающий отдельные файлы в контейнере Хранилище BLOB-объектов Azure.
base64	string	Содержимое, представленное в кодировке Base64.
url	string	Содержимое по определенному URL-адресу.

DocumentBuildMode

Режим сборки пользовательской модели документов.

Имя	Тип	Описание
neural	string	Поддержка документов с различными визуальными шаблонами.
template	string	Целевые документы с похожими визуальными шаблонами.

DocumentClassifierBuildOperationDetails

Получение объекта ответа Operation.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string	Дата и время (UTC) создания операции.
error	Error	Возникла ошибка.
kind	string: documentClassifierBuild	Тип операции.
lastUpdatedDateTime	string	Дата и время (UTC) последнего обновления состояния.
operationId	string	Operation ID
percentCompleted	integer	Ход выполнения операции (0–100).
resourceLocation	string	URL-адрес ресурса, на который нацелена эта операция.
result	DocumentClassifierDetails	Результат операции при успешном выполнении.
status	OperationStatus	Состояние операции. notStarted, Running, Completed или Failed
tags	object	Список атрибутов тега "ключ—значение", связанных с моделью документа.

DocumentClassifierDetails

Сведения о классификаторе документов.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этого классификатора документов.
baseClassifierId	string	Base classifierId, поверх которого был обучен классификатор.
classifierId	string	Уникальное имя классификатора документов.
createdDateTime	string	Дата и время (UTC) создания классификатора документов.
description	string	Описание классификатора документов.
docTypes	<string, ClassifierDocumentTypeDetails>	Список типов документов для классификации.
expirationDateTime	string	Дата и время (UTC), когда истечет срок действия классификатора документов.
warnings	Warning[]	Список предупреждений, возникших при сборке классификатора.

DocumentFieldSchema

Описание семантической схемы поля с использованием синтаксиса стиля схемы JSON.

Имя	Тип	Описание
description	string	Описание поля.
example	string	Пример содержимого поля.
items	DocumentFieldSchema	Схема типа поля каждого элемента массива.
properties	<string, DocumentFieldSchema>	Именованные вложенные поля поля объекта.
type	DocumentFieldType	Семантический тип данных значения поля.

DocumentFieldType

Семантический тип данных значения поля.

Имя	Тип	Описание
address	string	Проанализированный адрес.
array	string	Список подполей того же типа.
boolean	string	Логическое значение, нормализованное до true или false.
countryRegion	string	Страна или регион, нормализованный в формате ISO 3166-1 alpha-3 (например, США).
currency	string	Сумма валюты с необязательным символом валюты и единицей измерения.
date	string	Дата, нормализованная в формате ISO 8601 (ГГГГ-ММ-ДД).
integer	string	Целочисленное число, нормализованное до 64-разрядного целого числа со знаком.
number	string	Число с плавающей запятой, нормализованное до двойной точности с плавающей запятой.
object	string	Именованный список подполей потенциально различных типов.
phoneNumber	string	Номер телефона, нормализованный до формата E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Массив выбранных строковых значений.
selectionMark	string	Выбрано ли поле?
signature	string	Существует ли подпись?
string	string	Обычный текст.
time	string	Время, нормализованное до формата ISO 8601 (чч:мм:сс).

DocumentModelBuildOperationDetails

Получение объекта ответа Operation.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string	Дата и время (UTC) создания операции.
error	Error	Возникла ошибка.
kind	string: documentModelBuild	Тип операции.
lastUpdatedDateTime	string	Дата и время (UTC) последнего обновления состояния.
operationId	string	Operation ID
percentCompleted	integer	Ход выполнения операции (0–100).
resourceLocation	string	URL-адрес ресурса, на который нацелена эта операция.
result	DocumentModelDetails	Результат операции при успешном выполнении.
status	OperationStatus	Состояние операции. notStarted, Running, Completed или Failed
tags	object	Список атрибутов тега "ключ—значение", связанных с моделью документа.

DocumentModelComposeOperationDetails

Получение объекта ответа Operation.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string	Дата и время (UTC) создания операции.
error	Error	Возникла ошибка.
kind	string: documentModelCompose	Тип операции.
lastUpdatedDateTime	string	Дата и время (UTC) последнего обновления состояния.
operationId	string	Operation ID
percentCompleted	integer	Ход выполнения операции (0–100).
resourceLocation	string	URL-адрес ресурса, на который нацелена эта операция.
result	DocumentModelDetails	Результат операции при успешном выполнении.
status	OperationStatus	Состояние операции. notStarted, Running, Completed или Failed
tags	object	Список атрибутов тега "ключ—значение", связанных с моделью документа.

DocumentModelCopyToOperationDetails

Получение объекта ответа Operation.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string	Дата и время (UTC) создания операции.
error	Error	Возникла ошибка.
kind	string: documentModelCopyTo	Тип операции.
lastUpdatedDateTime	string	Дата и время (UTC) последнего обновления состояния.
operationId	string	Operation ID
percentCompleted	integer	Ход выполнения операции (0–100).
resourceLocation	string	URL-адрес ресурса, на который нацелена эта операция.
result	DocumentModelDetails	Результат операции при успешном выполнении.
status	OperationStatus	Состояние операции. notStarted, Running, Completed или Failed
tags	object	Список атрибутов тега "ключ—значение", связанных с моделью документа.

DocumentModelDetails

Сведения о модели документа.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой модели документа.
azureBlobFileListSource	AzureBlobFileListContentSource	Хранилище BLOB-объектов Azure список файлов с указанием обучающих данных. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Хранилище BLOB-объектов Azure расположение, содержащее обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
buildMode	DocumentBuildMode	Режим сборки пользовательской модели документов.
createdDateTime	string	Дата и время (UTC) создания модели документа.
description	string	Описание модели документа.
docTypes	<string, DocumentTypeDetails>	Поддерживаемые типы документов.
expirationDateTime	string	Дата и время (UTC), когда истечет срок действия модели документа.
modelId	string	Уникальное имя модели документа.
tags	object	Список атрибутов тега "ключ—значение", связанных с моделью документа.
warnings	Warning[]	Список предупреждений, возникших при построении модели.

DocumentTypeDetails

Сведения о типе документа.

Имя	Тип	Описание
buildMode	DocumentBuildMode	Режим сборки пользовательской модели документов.
description	string	Описание модели документа.
fieldConfidence	object	Оценка достоверности для каждого поля.
fieldSchema	<string, DocumentFieldSchema>	Описание семантической схемы документа с использованием синтаксиса стиля схемы JSON.

Error

Объект ошибки.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

ErrorResponse

Объект ответа об ошибке.

Имя	Тип	Описание
error	Error	Сведения об ошибке.

InnerError

Объект , содержащий более конкретные сведения об ошибке.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
innererror	InnerError	Внутренняя ошибка.
message	string	Понятное представление ошибки.

OperationKind

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

Имя	Тип	Описание
documentClassifierBuild	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 Operation

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Примеры

Get Operation

Sample Request

Sample Response

Определения

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

OperationKind

OperationStatus

Warning

Дополнительные ресурсы