Document Models - List Models

Service:

Azure AI Services

API Version:

2024-02-29-preview

Вывод списка всех моделей документов

GET {endpoint}/documentintelligence/documentModels?api-version=2024-02-29-preview

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	PagedDocumentModelDetails	Запрос выполнен успешно. 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 Document Models

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?api-version=2024-02-29-preview

Sample Response

Status code:

200

{
  "value": [
    {
      "modelId": "prebuilt-layout",
      "createdDateTime": "2021-07-30T00:00:00Z",
      "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.",
      "apiVersion": "2024-02-29-preview"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-02-29-preview"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

Определения

Имя	Описание
AzureBlobContentSource	Хранилище BLOB-объектов Azure содержимого.
AzureBlobFileListContentSource	Список файлов в Хранилище BLOB-объектов Azure.
DocumentBuildMode	Режим сборки пользовательской модели документов.
DocumentFieldSchema	Описание семантической схемы поля с использованием синтаксиса стиля схемы JSON.
DocumentFieldType	Семантический тип данных значения поля.
DocumentModelDetails	Сведения о модели документа.
DocumentTypeDetails	Сведения о типе документа.
Error	Объект error.
ErrorResponse	Объект ответа об ошибке.
InnerError	Объект , содержащий более конкретные сведения об ошибке.
PagedDocumentModelDetails	Коллекция Paged элементов DocumentModelDetails
Warning	Объект error.

AzureBlobContentSource

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

Имя	Тип	Описание
containerUrl	string	ХРАНИЛИЩЕ BLOB-ОБЪЕКТОВ AZURE URL-адрес контейнера.
prefix	string	Префикс имени BLOB-объекта.

AzureBlobFileListContentSource

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

Имя	Тип	Описание
containerUrl	string	ХРАНИЛИЩЕ BLOB-ОБЪЕКТОВ AZURE URL-адрес контейнера.
fileList	string	Путь к JSONL-файлу в контейнере с указанием подмножества документов.

DocumentBuildMode

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

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

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 (чч:мм:сс).

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

Объект error.

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

ErrorResponse

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

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

InnerError

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

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

PagedDocumentModelDetails

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

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу элементов
value	DocumentModelDetails[]	Элементы DocumentModelDetails на этой странице

Warning

Объект error.

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