Miscellaneous Operations - List Operations

Служба:: Azure AI Services

Версия API:: 2024-11-30

Выводит список всех операций.

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

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	PagedDocumentIntelligenceOperationDetails	Запрос выполнен успешно. Заголовки x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

PagedDocumentIntelligenceOperationDetails

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

Заголовки

x-ms-client-request-id: string

Other Status Codes

DocumentIntelligenceErrorResponse

Непредвиденное сообщение об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Get Operations

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

HTTP

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

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

Код состояния:: 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/documentintelligence/documentModels/myCustomModel",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}

Определения

Имя	Описание
AzureBlobContentSource	Содержимое хранилища BLOB-объектов Azure.
AzureBlobFileListContentSource	Список файлов в хранилище BLOB-объектов Azure.
ClassifierDocumentTypeDetails	Сведения о типе документа классификатора.
ContentSourceKind	Тип источника контента.
DocumentAnalysisFeature	Функции анализа документов для включения.
DocumentBuildMode	Режим сборки пользовательской модели документов.
DocumentClassifierBuildOperationDetails	Получение объекта ответа операции.
DocumentClassifierCopyToOperationDetails	Получение объекта ответа операции.
DocumentClassifierDetails	Сведения о классификаторе документов.
DocumentFieldSchema	Описание семантической схемы поля с помощью синтаксиса стиля схемы JSON.
DocumentFieldType	Семантический тип данных значения поля.
DocumentIntelligenceError	Объект ошибки.
DocumentIntelligenceErrorResponse	Объект ответа об ошибке.
DocumentIntelligenceInnerError	Объект, содержащий более конкретные сведения об ошибке.
DocumentIntelligenceOperationStatus	Состояние операции.
DocumentIntelligenceWarning	Объект ошибки.
DocumentModelBuildOperationDetails	Получение объекта ответа операции.
DocumentModelComposeOperationDetails	Получение объекта ответа операции.
DocumentModelCopyToOperationDetails	Получение объекта ответа операции.
DocumentModelDetails	Сведения о модели документа.
DocumentTypeDetails	Сведения о типе документа.
OperationKind	Тип операции.
PagedDocumentIntelligenceOperationDetails	Коллекция Paged элементов DocumentIntelligenceOperationDetails
SplitMode	Поведение разделения файлов.

AzureBlobContentSource

Object

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

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

AzureBlobFileListContentSource

Object

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

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

ClassifierDocumentTypeDetails

Object

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

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

ContentSourceKind

Перечисление

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

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

DocumentAnalysisFeature

Перечисление

Функции анализа документов для включения.

Значение	Описание
ocrHighResolution	Выполните OCR с более высоким разрешением для обработки документов с тонкой печатью.
languages	Включите обнаружение языка текстового содержимого.
barcodes	Включите обнаружение штрихкодов в документе.
formulas	Включите обнаружение математических выражений в документе.
keyValuePairs	Включите обнаружение пар значений общего ключа (полей формы) в документе.
styleFont	Включите распознавание различных стилей шрифтов.
queryFields	Включите извлечение дополнительных полей с помощью параметра запроса QueryFields.

DocumentBuildMode

Перечисление

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

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

DocumentClassifierBuildOperationDetails

Object

Получение объекта ответа операции.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string (date-time)	Дата и время (UTC) при создании операции.
error	DocumentIntelligenceError	Обнаружена ошибка.
kind	string: documentClassifierBuild	Тип операции.
lastUpdatedDateTime	string (date-time)	Дата и время (UTC) при последнем обновлении состояния.
operationId	string	Идентификатор операции
percentCompleted	integer (int32) minimum: 0 maximum: 100	Ход выполнения операции (0–100).
resourceLocation	string (uri)	URL-адрес ресурса, предназначенного для этой операции.
result	DocumentClassifierDetails	Результат операции при успешном выполнении.
status	DocumentIntelligenceOperationStatus	Состояние операции. notStarted, running, completed или failed
tags	object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentClassifierCopyToOperationDetails

Object

Получение объекта ответа операции.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string (date-time)	Дата и время (UTC) при создании операции.
error	DocumentIntelligenceError	Обнаружена ошибка.
kind	string: documentClassifierCopyTo	Тип операции.
lastUpdatedDateTime	string (date-time)	Дата и время (UTC) при последнем обновлении состояния.
operationId	string	Идентификатор операции
percentCompleted	integer (int32) minimum: 0 maximum: 100	Ход выполнения операции (0–100).
resourceLocation	string (uri)	URL-адрес ресурса, предназначенного для этой операции.
result	DocumentClassifierDetails	Результат операции при успешном выполнении.
status	DocumentIntelligenceOperationStatus	Состояние операции. notStarted, running, completed или failed
tags	object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentClassifierDetails

Object

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

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этого классификатора документов.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Базовый классификаторId поверх которого был обучен классификатор.
classifierId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Уникальное имя классификатора документов.
createdDateTime	string (date-time)	Дата и время (UTC) при создании классификатора документов.
description	string maxLength: 4096	Описание классификатора документов.
docTypes	<string, ClassifierDocumentTypeDetails>	Список типов документов для классификации.
expirationDateTime	string (date-time)	Дата и время (UTC) при истечении срока действия классификатора документа.
modifiedDateTime	string (date-time)	Дата и время (UTC) при последнем изменении модели документа.
warnings	DocumentIntelligenceWarning[]	Список предупреждений, возникших при создании классификатора.

DocumentFieldSchema

Object

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

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

DocumentFieldType

Перечисление

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

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

DocumentIntelligenceError

Object

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

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

DocumentIntelligenceErrorResponse

Object

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

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

DocumentIntelligenceInnerError

Object

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

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

DocumentIntelligenceOperationStatus

Перечисление

Состояние операции.

Значение	Описание
notStarted	Операция еще не запущена.
running	Операция выполняется.
failed	Операция завершилась ошибкой.
succeeded	Операция выполнена успешно.
canceled	Операция отменена.
skipped	Операция пропущена.

DocumentIntelligenceWarning

Object

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

Имя	Тип	Описание
code	string	Один из определяемых сервером набор кодов предупреждений.
message	string	Доступное для чтения представление предупреждения.
target	string	Целевой объект ошибки.

DocumentModelBuildOperationDetails

Object

Получение объекта ответа операции.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string (date-time)	Дата и время (UTC) при создании операции.
error	DocumentIntelligenceError	Обнаружена ошибка.
kind	string: documentModelBuild	Тип операции.
lastUpdatedDateTime	string (date-time)	Дата и время (UTC) при последнем обновлении состояния.
operationId	string	Идентификатор операции
percentCompleted	integer (int32) minimum: 0 maximum: 100	Ход выполнения операции (0–100).
resourceLocation	string (uri)	URL-адрес ресурса, предназначенного для этой операции.
result	DocumentModelDetails	Результат операции при успешном выполнении.
status	DocumentIntelligenceOperationStatus	Состояние операции. notStarted, running, completed или failed
tags	object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentModelComposeOperationDetails

Object

Получение объекта ответа операции.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string (date-time)	Дата и время (UTC) при создании операции.
error	DocumentIntelligenceError	Обнаружена ошибка.
kind	string: documentModelCompose	Тип операции.
lastUpdatedDateTime	string (date-time)	Дата и время (UTC) при последнем обновлении состояния.
operationId	string	Идентификатор операции
percentCompleted	integer (int32) minimum: 0 maximum: 100	Ход выполнения операции (0–100).
resourceLocation	string (uri)	URL-адрес ресурса, предназначенного для этой операции.
result	DocumentModelDetails	Результат операции при успешном выполнении.
status	DocumentIntelligenceOperationStatus	Состояние операции. notStarted, running, completed или failed
tags	object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentModelCopyToOperationDetails

Object

Получение объекта ответа операции.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этой операции.
createdDateTime	string (date-time)	Дата и время (UTC) при создании операции.
error	DocumentIntelligenceError	Обнаружена ошибка.
kind	string: documentModelCopyTo	Тип операции.
lastUpdatedDateTime	string (date-time)	Дата и время (UTC) при последнем обновлении состояния.
operationId	string	Идентификатор операции
percentCompleted	integer (int32) minimum: 0 maximum: 100	Ход выполнения операции (0–100).
resourceLocation	string (uri)	URL-адрес ресурса, предназначенного для этой операции.
result	DocumentModelDetails	Результат операции при успешном выполнении.
status	DocumentIntelligenceOperationStatus	Состояние операции. notStarted, running, completed или failed
tags	object	Список атрибутов тега "ключ-значение", связанных с моделью документа.

DocumentModelDetails

Object

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

Имя	Тип	Default value	Описание
apiVersion	string		Версия API, используемая для создания этой модели документов.
azureBlobFileListSource	AzureBlobFileListContentSource		Список файлов хранилища BLOB-объектов Azure, указывающий обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Расположение хранилища BLOB-объектов Azure, содержащее обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource.
buildMode	DocumentBuildMode		Режим сборки пользовательской модели документов.
classifierId	string		Для составных моделей настраиваемый классификатор для разделения и классификации входного файла.
createdDateTime	string (date-time)		Дата и время (UTC) при создании модели документа.
description	string maxLength: 4096		Описание модели документа.
docTypes	<string, DocumentTypeDetails>		Поддерживаемые типы документов.
expirationDateTime	string (date-time)		Дата и время (UTC) при истечении срока действия модели документа.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Уникальное имя модели документа.
modifiedDateTime	string (date-time)		Дата и время (UTC) при последнем изменении модели документа.
split	SplitMode	none	Для составных моделей поведение разделения файлов.
tags	object		Список атрибутов тега "ключ-значение", связанных с моделью документа.
trainingHours	number (float)		Количество часов GPU, используемых для обучения моделей версии 100.
warnings	DocumentIntelligenceWarning[]		Список предупреждений, возникших при создании модели.

DocumentTypeDetails

Object

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

Имя	Тип	Описание
buildMode	DocumentBuildMode	Режим сборки пользовательской модели документов.
confidenceThreshold	number (float)	Выполните анализ только в том случае, если достоверность docType превышает пороговое значение.
description	string maxLength: 4096	Описание модели документа.
features	DocumentAnalysisFeature[]	Список необязательных функций анализа.
fieldConfidence	object	Оценка достоверности для каждого поля.
fieldSchema	<string, DocumentFieldSchema>	Описание семантической схемы документа с помощью синтаксиса стиля схемы JSON.
maxDocumentsToAnalyze	integer (int32)	Максимальное количество документов указанного типа для анализа. Default=all.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Модель документов, используемая для анализа документов с указанным типом.
queryFields	string[]	Список дополнительных полей для извлечения. Бывший. "NumberOfGuests,StoreNumber"

OperationKind

Перечисление

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

Значение	Описание
documentModelBuild	Создание новой пользовательской модели документов.
documentModelCompose	Создание новой пользовательской модели документов из существующих моделей.
documentModelCopyTo	Скопируйте существующую модель документа в потенциально другой ресурс, регион или подписку.
documentClassifierCopyTo	Скопируйте существующий классификатор документов в потенциально другой ресурс, регион или подписку.
documentClassifierBuild	Создайте новую пользовательскую модель классификатора.

PagedDocumentIntelligenceOperationDetails

Object

Коллекция Paged элементов DocumentIntelligenceOperationDetails

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	DocumentIntelligenceOperationDetails[]: DocumentClassifierBuildOperationDetails[] DocumentClassifierCopyToOperationDetails[] DocumentModelBuildOperationDetails[] DocumentModelComposeOperationDetails[] DocumentModelCopyToOperationDetails[]	Элементы DocumentIntelligenceOperationDetails на этой странице

SplitMode

Перечисление

Поведение разделения файлов.

Значение	Описание
auto	Автоматически разделенный файл на документы.
none	Обрабатывает весь файл как один документ.
perPage	Обрабатывать каждую страницу в файле как отдельный документ.

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

Miscellaneous Operations - List Operations

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

Get Operations

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

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

Определения

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentAnalysisFeature

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierCopyToOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceOperationStatus

DocumentIntelligenceWarning

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

OperationKind

PagedDocumentIntelligenceOperationDetails

SplitMode