Document Models - Get Model
Возвращает подробные сведения о модели документа.
GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
endpoint
|
path | True |
string |
Конечная точка службы аналитики документов. |
model
|
path | True |
string |
Уникальное имя модели документа. Regex pattern: |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Непрозрачный, глобально уникальный, созданный клиентом строковый идентификатор для запроса. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос выполнен успешно. Headers x-ms-client-request-id: string |
|
Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
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 Custom Document Model |
Get Prebuilt Document Model |
Get Custom Document Model
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-02-29-preview
Sample Response
{
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-24T12:54:35Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"myForm": {
"fieldSchema": {
"Name": {
"type": "string"
},
"Date": {
"type": "date"
},
"Amount": {
"type": "number"
}
},
"buildMode": "template",
"fieldConfidence": {
"Name": 0.9,
"Date": 0.95,
"Amount": 0.93
}
}
},
"tags": {
"createdBy": "myUserId"
}
}
Get Prebuilt Document Model
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-02-29-preview
Sample Response
{
"modelId": "prebuilt-invoice",
"description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
"createdDateTime": "2021-07-30T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"prebuilt:invoice": {
"fieldSchema": {
"CustomerName": {
"type": "string"
},
"CustomerId": {
"type": "string"
},
"PurchaseOrder": {
"type": "string"
},
"InvoiceId": {
"type": "string"
},
"InvoiceDate": {
"type": "date"
},
"DueDate": {
"type": "date"
},
"VendorName": {
"type": "string"
},
"VendorAddress": {
"type": "string"
},
"VendorAddressRecipient": {
"type": "string"
},
"CustomerAddress": {
"type": "string"
},
"CustomerAddressRecipient": {
"type": "string"
},
"BillingAddress": {
"type": "string"
},
"BillingAddressRecipient": {
"type": "string"
},
"ShippingAddress": {
"type": "string"
},
"ShippingAddressRecipient": {
"type": "string"
},
"SubTotal": {
"type": "number"
},
"TotalTax": {
"type": "number"
},
"InvoiceTotal": {
"type": "number"
},
"AmountDue": {
"type": "number"
},
"PreviousUnpaidBalance": {
"type": "number"
},
"RemittanceAddress": {
"type": "string"
},
"RemittanceAddressRecipient": {
"type": "string"
},
"ServiceAddress": {
"type": "string"
},
"ServiceAddressRecipient": {
"type": "string"
},
"ServiceStartDate": {
"type": "date"
},
"ServiceEndDate": {
"type": "date"
},
"Items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"Date": {
"type": "date"
},
"Description": {
"type": "string"
},
"Quantity": {
"type": "number"
},
"ProductCode": {
"type": "string"
},
"Tax": {
"type": "number"
},
"Unit": {
"type": "string"
},
"UnitPrice": {
"type": "number"
}
}
}
}
}
}
},
"tags": {}
}
Определения
Имя | Описание |
---|---|
Azure |
содержимое Хранилище BLOB-объектов Azure. |
Azure |
Список файлов в Хранилище BLOB-объектов Azure. |
Document |
Режим сборки пользовательской модели документов. |
Document |
Описание семантической схемы поля с использованием синтаксиса стиля схемы JSON. |
Document |
Семантический тип данных значения поля. |
Document |
Сведения о модели документа. |
Document |
Сведения о типе документа. |
Error |
Объект ошибки. |
Error |
Объект ответа об ошибке. |
Inner |
Объект , содержащий более конкретные сведения об ошибке. |
Warning |
Объект ошибки. |
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 |
Схема типа поля каждого элемента массива. |
|
properties |
<string,
Document |
Именованные вложенные поля поля объекта. |
type |
Семантический тип данных значения поля. |
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 |
Хранилище BLOB-объектов Azure список файлов с указанием обучающих данных. Необходимо указать azureBlobSource или azureBlobFileListSource. |
|
azureBlobSource |
Хранилище BLOB-объектов Azure расположение, содержащее обучающие данные. Необходимо указать azureBlobSource или azureBlobFileListSource. |
|
buildMode |
Режим сборки пользовательской модели документов. |
|
createdDateTime |
string |
Дата и время (UTC) создания модели документа. |
description |
string |
Описание модели документа. |
docTypes |
<string,
Document |
Поддерживаемые типы документов. |
expirationDateTime |
string |
Дата и время (UTC), когда истечет срок действия модели документа. |
modelId |
string |
Уникальное имя модели документа. |
tags |
object |
Список атрибутов тега "ключ—значение", связанных с моделью документа. |
warnings |
Warning[] |
Список предупреждений, возникших при построении модели. |
DocumentTypeDetails
Сведения о типе документа.
Имя | Тип | Описание |
---|---|---|
buildMode |
Режим сборки пользовательской модели документов. |
|
description |
string |
Описание модели документа. |
fieldConfidence |
object |
Оценка достоверности для каждого поля. |
fieldSchema |
<string,
Document |
Описание семантической схемы документа с использованием синтаксиса стиля схемы JSON. |
Error
Объект ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Один из серверных наборов кодов ошибок. |
details |
Error[] |
Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке. |
innererror |
Объект , содержащий более конкретные сведения об ошибке, чем текущий объект. |
|
message |
string |
Понятное представление ошибки. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Объект ответа об ошибке.
Имя | Тип | Описание |
---|---|---|
error |
Сведения об ошибке. |
InnerError
Объект , содержащий более конкретные сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
code |
string |
Один из серверных наборов кодов ошибок. |
innererror |
Внутренняя ошибка. |
|
message |
string |
Понятное представление ошибки. |
Warning
Объект ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Один из серверных наборов кодов предупреждений. |
message |
string |
Понятное представление предупреждения. |
target |
string |
Целевой объект ошибки. |