Document Models - List Models

Ссылка

Служба:: Azure AI Services

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

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

GET {endpoint}/documentintelligence/documentModels?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	PagedDocumentModelDetails	Запрос выполнен успешно. Заголовки x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

PagedDocumentModelDetails

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

Заголовки

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 Document Models

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

HTTP

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

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

Код состояния:: 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-11-30"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

Определения

Имя	Описание
AzureBlobContentSource	Содержимое хранилища BLOB-объектов Azure.
AzureBlobFileListContentSource	Список файлов в хранилище BLOB-объектов Azure.
DocumentAnalysisFeature	Функции анализа документов для включения.
DocumentBuildMode	Режим сборки пользовательской модели документов.
DocumentFieldSchema	Описание семантической схемы поля с помощью синтаксиса стиля схемы JSON.
DocumentFieldType	Семантический тип данных значения поля.
DocumentIntelligenceError	Объект ошибки.
DocumentIntelligenceErrorResponse	Объект ответа об ошибке.
DocumentIntelligenceInnerError	Объект, содержащий более конкретные сведения об ошибке.
DocumentIntelligenceWarning	Объект ошибки.
DocumentModelDetails	Сведения о модели документа.
DocumentTypeDetails	Сведения о типе документа.
PagedDocumentModelDetails	Коллекция paged элементов DocumentModelDetails
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-файлу в контейнере с указанием подмножества документов.

DocumentAnalysisFeature

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

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

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

DocumentBuildMode

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

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

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

DocumentFieldSchema

Object

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

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

DocumentFieldType

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

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

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

DocumentIntelligenceError

Object

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

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

DocumentIntelligenceErrorResponse

Object

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

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

DocumentIntelligenceInnerError

Object

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

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

DocumentIntelligenceWarning

Object

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

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

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"

PagedDocumentModelDetails

Object

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

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

SplitMode

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

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

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

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

Document Models - List Models

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

Get Document Models

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

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

Определения

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceWarning

DocumentModelDetails

DocumentTypeDetails

PagedDocumentModelDetails

SplitMode

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