Аналитика документов Azure (распознаватель документов)
Извлекает текст (печатный и рукописный код OCR) и дополнительную информацию (таблицы, флажки, поля и пары значений ключа) из PDF-файлов, изображений или документов Microsoft Office и форм в структурированные данные на основе предварительно обученных моделей (макета, счета, квитанции, идентификатора, визитной карточки) или пользовательской модели, созданной набором репрезентативных форм обучения с помощью распознавания документов с использованием искусственного интеллекта.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Стандарт | Все регионы Power Automate , кроме следующих: - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: - Министерство обороны США (DoD) |
| Power Apps | - | Недоступно |
| Power Automate | Стандарт | Все регионы Power Automate , кроме следующих: - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Microsoft |
| URL | https://aka.ms/formrecognizer |
| Адрес электронной почты | formrecog_contact@microsoft.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
| Веб-сайт | https://aka.ms/formrecognizer |
| Политика конфиденциальности | https://aka.ms/form-recognizer/privacy |
| Категории | Искусственный интеллект; Бизнес-аналитика |
Соединитель Azure AI Document Intelligence (прежнее название — Распознаватель документов) обеспечивает интеграцию с Azure AI Document Intelligence. Он позволяет анализировать и извлекать информацию из форм, счетов, квитанций, визитных карточек, документов идентификаторов и нескольких других типов документов.
Предпосылки
Чтобы использовать эту интеграцию, вам потребуется ресурс Аналитики документов Azure на портале Azure. Создайте ссылку на ресурс. Вы получите конечную точку и ключ для проверки подлинности приложений. Чтобы сделать подключение, укажите ключ учетной записи, URL-адрес сайта и выберите "Создать подключение". Дополнительные сведения см. в статье об затратах на операции подключения.
Получение учетных данных
- Откройте ресурс Аналитики документов на портале Azure (см. предварительные требования).
- Выберите ключи и конечную точку в разделе "Управление ресурсами"
- Скопируйте конечную точку и ключ и используйте их для создания нового подключения.
Начало работы с соединителем
Самый простой способ попробовать соединитель Аналитики документов — использовать все предварительно созданные модели (предварительно созданные счета, предварительно созданные макеты и т. д.). Укажите PDF-файл или изображение документа. Анализ с помощью операции соединителя на основе типа документа и проверки обнаруженных полей. Полный список моделей и поддерживаемых функций здесь.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| Ключ API | Укажите имя ресурса Document Intellignce и ключ API. | Все регионы | Доступный для общего пользования |
| Управляемое удостоверение Logic Apps | Создание подключения с помощью управляемого удостоверения LogicApps | Только LOGICAPPS | Доступный для общего пользования |
| Интегрированный идентификатор Microsoft Entra | Доступ к идентификатору Microsoft Entra | Все регионы | Недоступен для совместного использования |
| По умолчанию [не рекомендуется] | Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. | Все регионы | Недоступен для совместного использования |
Ключ API
Идентификатор проверки подлинности: keyBasedAuth
Применимо: все регионы
Укажите имя ресурса Document Intellignce и ключ API.
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ учетной записи | securestring | Ключ учетной записи аналитики документов | True |
| URL-адрес конечной точки | струна | URL-адрес конечной точки аналитики документов (пример: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
True |
Управляемое удостоверение Logic Apps
Идентификатор проверки подлинности: managedIdentityAuth
Применимо: только LOGICAPPS
Создание подключения с помощью управляемого удостоверения LogicApps
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Управляемое удостоверение LogicApps | управляемая идентичность | Вход с помощью управляемого удостоверения Logic Apps | True |
| URL-адрес конечной точки | струна | URL-адрес конечной точки аналитики документов (пример: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
True |
интеграция Microsoft Entra ID
Идентификатор проверки подлинности: oauth
Применимо: все регионы
Доступ к идентификатору Microsoft Entra
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| URL-адрес конечной точки | струна | URL-адрес конечной точки аналитики документов (пример: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
True |
По умолчанию [не рекомендуется]
Применимо: все регионы
Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ учетной записи | securestring | Ключ учетной записи аналитики документов | True |
| URL-адрес конечной точки | струна | URL-адрес конечной точки аналитики документов (пример: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 1200 | 60 секунд |
Действия
| Анализ визитной карточки (не рекомендуется) [DEPRECATED] |
Извлечение текста поля и семантических значений из заданного документа визитной карточки (не рекомендуется). |
| Анализ документа для предварительно созданных или пользовательских моделей (API версии 3.x) |
Извлечение пар "ключ-значение", таблиц и семантических значений из данного документа (API версии 3.x). |
| Анализ документа для предварительно созданных или пользовательских моделей (API версии 4.x) |
Извлеките пары "ключ-значение", таблицы и семантические значения из данного документа (API версии 4.x). |
| Анализ документа идентификатора (не рекомендуется) [DEPRECATED] |
Извлечение текста поля и семантических значений из заданного документа идентификатора (не рекомендуется). |
| Анализ квитанции (не рекомендуется) [DEPRECATED] |
Извлечение текста поля и семантических значений из указанного документа квитанции (не рекомендуется). |
| Анализ макета (не рекомендуется) [DEPRECATED] |
Извлеките текст и сведения о макете из данного документа (не рекомендуется). |
| Анализ пользовательской формы (не рекомендуется) [DEPRECATED] |
Извлеките пары "ключ-значение", таблицы и семантические значения из заданного документа (не рекомендуется). |
| Анализ счета (не рекомендуется) [DEPRECATED] |
Извлечение текста поля и семантических значений из указанного документа счета (не рекомендуется). |
| Классификация документа с помощью классификатора документов (API версии 3.1) |
Классифицируйте документ с помощью классификатора документов (API версии 3.1). |
| Классификация документа с помощью классификатора документов (API версии 4.x) |
Классифицируйте документ с помощью классификатора документов (API версии 4.x). |
Анализ визитной карточки (не рекомендуется) [DEPRECATED]
Извлечение текста поля и семантических значений из заданного документа визитной карточки (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение текстовых сведений
|
includeTextDetails | boolean |
Включите текстовые строки и ссылки на элементы в результат. Значение по умолчанию: True (только для соединителя FR). |
|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт счета. Поддерживаемый языковой стандарт включает: en-US. |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Файл PDF-документа или изображения (JPG или PNG) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа в очереди.
Анализ документа для предварительно созданных или пользовательских моделей (API версии 3.x)
Извлечение пар "ключ-значение", таблиц и семантических значений из данного документа (API версии 3.x).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Версия API аналитики документов
|
api-version | True | string |
Версия API аналитики документов. |
|
Идентификатор модели
|
modelId | True | string |
Предварительно созданные modelIds: предварительно считываемые, предварительно созданные макеты, предварительно созданные документы, предварительно созданные бизнес-card, предварительно созданные-idDocument, предварительно созданные счета-фактуры, предварительно созданные квитанции, предварительно созданные-tax.us.w2, предварительно созданные-вакцинацииCard, prebuilt-healthInsuranceCard.us. Пользовательский формат modelId — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Уникальное имя модели. |
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Региональные настройки
|
locale | string |
Указание языкового стандарта для распознавания текста и анализа документов. Значение может содержать только языковой код (например, en, fr) или тег языка BCP 47 (например, "en-US"). |
|
|
Тип строкового индекса
|
stringIndexType | string |
Метод, используемый для вычисления смещения и длины строки. Поддерживаемые параметры: textElements, юникодPoint, utf16CodeUnit. |
|
|
Необязательные и премиум-функции
|
features | array |
Список необязательных функций анализа (таких как ocrHighResolution, языки, штрихкоды, формулы, keyValuePairs и styleFont). |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Pdf-документ или изображение (JPG, PNG, BMP, TIFF) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа.
Анализ документа для предварительно созданных или пользовательских моделей (API версии 4.x)
Извлеките пары "ключ-значение", таблицы и семантические значения из данного документа (API версии 4.x).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Версия API аналитики документов
|
api-version | True | string |
Версия API аналитики документов. |
|
Идентификатор модели
|
modelId | True | string |
Предварительно созданные моделиIds: предварительно созданная, считываемая, предварительно созданные макеты, предварительно созданные бизнес-card, предварительно созданные-idDocument, предварительно созданные счета, предварительно созданные-квитанции, предварительно созданные-tax.us.w2, предварительно созданные-вакцинацииCard, prebuilt-healthInsuranceCard.us, предварительно созданные-tax.us.1098E, предварительно созданные-tax.us.1098E, предварительно созданные-tax.us.1098T, предварительно созданные контракты и т. д. Пользовательский формат modelId — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Уникальное имя модели. |
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Pdf-документ или изображение (JPG, PNG, BMP, TIFF) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Региональные настройки
|
locale | string |
Указание языкового стандарта для распознавания текста и анализа документов. Значение может содержать только языковой код (например, en, fr) или тег языка BCP 47 (например, "en-US"). |
|
|
Тип строкового индекса
|
stringIndexType | string |
Метод, используемый для вычисления смещения и длины строки. Поддерживаемые параметры: textElements, юникодPoint, utf16CodeUnit. |
|
|
Необязательные и премиум-функции
|
features | array |
Список необязательных функций анализа (таких как ocrHighResolution, языки, штрихкоды, формулы, keyValuePairs, styleFont и queryFields). |
|
|
Поля запроса
|
queryFields | array |
Список дополнительных полей для извлечения. Например: "NumberOfGuests,StoreNumber" |
|
|
Формат содержимого вывода
|
outputContentFormat | string |
Формат содержимого результата анализа верхнего уровня. |
Возвращаемое значение
Состояние и результат операции анализа.
Анализ документа идентификатора (не рекомендуется) [DEPRECATED]
Извлечение текста поля и семантических значений из заданного документа идентификатора (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение текстовых сведений
|
includeTextDetails | boolean |
Включите текстовые строки и ссылки на элементы в результат. Значение по умолчанию: True (только для соединителя FR). |
|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Файл PDF-документа или изображения (JPG или PNG) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа в очереди.
Анализ квитанции (не рекомендуется) [DEPRECATED]
Извлечение текста поля и семантических значений из указанного документа квитанции (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение текстовых сведений
|
includeTextDetails | boolean |
Включите текстовые строки и ссылки на элементы в результат. Значение по умолчанию: True (только для соединителя FR). |
|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт счета. Поддерживаемый языковой стандарт включает: en-US. |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Файл PDF-документа или изображения (JPG или PNG) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа в очереди.
Анализ макета (не рекомендуется) [DEPRECATED]
Извлеките текст и сведения о макете из данного документа (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Language
|
language | string |
Код языка BCP-47 текста в документе. |
|
|
Порядок чтения
|
readingOrder | string |
Необязательный параметр, чтобы указать, какой алгоритм порядка чтения должен применяться при упорядочении текстовых элементов извлечения. Может быть "базовым" или "естественным". Значение по умолчанию — базовый, если он не указан. |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Файл PDF-документа или изображения (JPG или PNG) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа в очереди.
Анализ пользовательской формы (не рекомендуется) [DEPRECATED]
Извлеките пары "ключ-значение", таблицы и семантические значения из заданного документа (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор модели
|
modelId | True | string |
Формат — uuid. Идентификатор модели. |
|
Включение текстовых сведений
|
includeTextDetails | boolean |
Включите текстовые строки и ссылки на элементы в результат. Значение по умолчанию: True (только для соединителя FR). |
|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Файл PDF-документа или изображения (JPG или PNG) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа в очереди.
Анализ счета (не рекомендуется) [DEPRECATED]
Извлечение текста поля и семантических значений из указанного документа счета (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение текстовых сведений
|
includeTextDetails | boolean |
Включите текстовые строки и ссылки на элементы в результат. Значение по умолчанию: True (только для соединителя FR). |
|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения сведений о счете из отдельных страниц и диапазона страниц (например, страниц 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт счета. Поддерживаемый языковой стандарт включает: en-US. |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Файл PDF-документа или изображения (JPG или PNG) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа в очереди.
Классификация документа с помощью классификатора документов (API версии 3.1)
Классифицируйте документ с помощью классификатора документов (API версии 3.1).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор классификатора
|
classifierId | True | string |
Формат — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Уникальное имя классификатора. |
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения информации из отдельных страниц и диапазона страниц (например, страницы 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Региональные настройки
|
locale | string |
Указание языкового стандарта для распознавания текста и анализа документов. Значение может содержать только языковой код (например, en, fr) или тег языка BCP 47 (например, "en-US"). |
|
|
Тип строкового индекса
|
stringIndexType | string |
Метод, используемый для вычисления смещения и длины строки. Поддерживаемые параметры: textElements, юникодPoint, utf16CodeUnit. |
|
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Pdf-документ или изображение (JPG, PNG, BMP, TIFF) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
Возвращаемое значение
Состояние и результат операции анализа.
Классификация документа с помощью классификатора документов (API версии 4.x)
Классифицируйте документ с помощью классификатора документов (API версии 4.x).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Версия API аналитики документов
|
api-version | True | string |
Версия API аналитики документов. |
|
Идентификатор классификатора
|
classifierId | True | string |
Формат — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Уникальное имя классификатора. |
|
Содержимое файла документа и изображения
|
inputFileContent | binary |
Pdf-документ или изображение (JPG, PNG, BMP, TIFF) для анализа. |
|
|
URL-адрес документа и изображения
|
inputFileUrl | string |
Путь url-адреса для входного файла. Альтернатива содержимому файла документа или изображения. |
|
|
Режим разделения
|
split | string |
Поведение разделения файлов. |
|
|
Страницы
|
pages | string |
Выбор страницы для документов PDF и TIFF для извлечения информации из отдельных страниц и диапазона страниц (например, страницы 2 и страниц 5-7) путем ввода номеров и диапазонов страниц, разделенных запятыми (например, "2, 5-7"). Если не задано, все страницы будут обработаны. |
|
|
Региональные настройки
|
locale | string |
Указание языкового стандарта для распознавания текста и анализа документов. Значение может содержать только языковой код (например, en, fr) или тег языка BCP 47 (например, "en-US"). |
|
|
Тип строкового индекса
|
stringIndexType | string |
Метод, используемый для вычисления смещения и длины строки. Поддерживаемые параметры: textElements, юникодPoint, utf16CodeUnit. |
Возвращаемое значение
Состояние и результат операции анализа.
Определения
OperationStatus
LayoutAnalyzeOperationResult
Состояние и результат операции анализа в очереди.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | OperationStatus |
Состояние операции в очереди. |
|
createdDateTime
|
createdDateTime | string |
Дата и время (UTC) была отправлена операция анализа. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Дата и время (UTC) при последнем обновлении состояния. |
|
analyzeResult
|
analyzeResult | LayoutAnalyzeResult |
Анализ результата операции. |
InvoiceAnalyzeOperationResult
Состояние и результат операции анализа в очереди.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | OperationStatus |
Состояние операции в очереди. |
|
createdDateTime
|
createdDateTime | string |
Дата и время (UTC) была отправлена операция анализа. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Дата и время (UTC) при последнем обновлении состояния. |
|
analyzeResult
|
analyzeResult | InvoiceAnalyzeResult |
Анализ результата операции. |
BusinessCardAnalyzeOperationResult
Состояние и результат операции анализа в очереди.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | OperationStatus |
Состояние операции в очереди. |
|
createdDateTime
|
createdDateTime | string |
Дата и время (UTC) была отправлена операция анализа. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Дата и время (UTC) при последнем обновлении состояния. |
|
analyzeResult
|
analyzeResult | BusinessCardAnalyzeResult |
Анализ результата операции. |
ReceiptAnalyzeOperationResult
Состояние и результат операции анализа в очереди.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | OperationStatus |
Состояние операции в очереди. |
|
createdDateTime
|
createdDateTime | string |
Дата и время (UTC) была отправлена операция анализа. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Дата и время (UTC) при последнем обновлении состояния. |
|
analyzeResult
|
analyzeResult | ReceiptAnalyzeResult |
Анализ результата операции. |
IdAnalyzeOperationResult
Состояние и результат операции анализа в очереди.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | OperationStatus |
Состояние операции в очереди. |
|
createdDateTime
|
createdDateTime | string |
Дата и время (UTC) была отправлена операция анализа. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Дата и время (UTC) при последнем обновлении состояния. |
|
analyzeResult
|
analyzeResult | IdAnalyzeResult |
Анализ результата операции. |
CustomFormsAnalyzeOperationResult
Состояние и результат операции анализа в очереди.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | OperationStatus |
Состояние операции в очереди. |
|
createdDateTime
|
createdDateTime | string |
Дата и время (UTC) была отправлена операция анализа. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Дата и время (UTC) при последнем обновлении состояния. |
|
analyzeResult
|
analyzeResult | CustomFormsAnalyzeResult |
Анализ результата операции. |
FormOperationError
Ошибка, сообщаемая во время операции.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
сообщение
|
message | string |
Сообщение об ошибке. |
LayoutAnalyzeResult
Анализ результата операции.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия схемы, используемая для этого результата. |
|
readResults
|
readResults | array of ReadResult |
Текст, извлеченный из входных данных. |
|
pageResults
|
pageResults | array of PageResult |
Сведения на уровне страницы, извлеченные из входных данных. |
|
Ошибки
|
errors | array of FormOperationError |
Список ошибок, сообщаемых во время операции анализа. |
InvoiceAnalyzeResult
Анализ результата операции.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия схемы, используемая для этого результата. |
|
readResults
|
readResults | array of ReadResult |
Текст, извлеченный из входных данных. |
|
pageResults
|
pageResults | array of PageResult |
Сведения на уровне страницы, извлеченные из входных данных. |
|
documentResults
|
documentResults | array of InvoiceDocumentResult |
Сведения на уровне документа, извлеченные из входных данных. |
|
Ошибки
|
errors | array of FormOperationError |
Список ошибок, сообщаемых во время операции анализа. |
BusinessCardAnalyzeResult
Анализ результата операции.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия схемы, используемая для этого результата. |
|
readResults
|
readResults | array of ReadResult |
Текст, извлеченный из входных данных. |
|
pageResults
|
pageResults | array of PageResult |
Сведения на уровне страницы, извлеченные из входных данных. |
|
documentResults
|
documentResults | array of BusinessCardDocumentResult |
Сведения на уровне документа, извлеченные из входных данных. |
|
Ошибки
|
errors | array of FormOperationError |
Список ошибок, сообщаемых во время операции анализа. |
ReceiptAnalyzeResult
Анализ результата операции.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия схемы, используемая для этого результата. |
|
readResults
|
readResults | array of ReadResult |
Текст, извлеченный из входных данных. |
|
pageResults
|
pageResults | array of PageResult |
Сведения на уровне страницы, извлеченные из входных данных. |
|
documentResults
|
documentResults | array of ReceiptDocumentResult |
Сведения на уровне документа, извлеченные из входных данных. |
|
Ошибки
|
errors | array of FormOperationError |
Список ошибок, сообщаемых во время операции анализа. |
IdAnalyzeResult
Анализ результата операции.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия схемы, используемая для этого результата. |
|
readResults
|
readResults | array of ReadResult |
Текст, извлеченный из входных данных. |
|
pageResults
|
pageResults | array of PageResult |
Сведения на уровне страницы, извлеченные из входных данных. |
|
documentResults
|
documentResults | array of IdDocumentResult |
Сведения на уровне документа, извлеченные из входных данных. |
|
Ошибки
|
errors | array of FormOperationError |
Список ошибок, сообщаемых во время операции анализа. |
CustomFormsAnalyzeResult
Анализ результата операции.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия схемы, используемая для этого результата. |
|
readResults
|
readResults | array of ReadResult |
Текст, извлеченный из входных данных. |
|
pageResults
|
pageResults | array of PageResult |
Сведения на уровне страницы, извлеченные из входных данных. |
|
documentResults
|
documentResults | array of CustomFormsDocumentResult |
Сведения на уровне документа, извлеченные из входных данных. |
|
Ошибки
|
errors | array of FormOperationError |
Список ошибок, сообщаемых во время операции анализа. |
ReadResult
Текст, извлеченный из страницы в входном документе.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Номер страницы на основе 1 в входном документе. |
|
угол
|
angle | float |
Общая ориентация текста в часовом направлении, измеряемая в градусах между (-180, 180]. |
|
Ширина
|
width | float |
Ширина изображения/PDF в пикселях/дюймах соответственно. |
|
height
|
height | float |
Высота изображения/PDF в пикселях/дюймах соответственно. |
|
единица
|
unit | string |
Единица, используемая свойствами width, height и boundingBox. Для изображений единица — "пиксель". Для PDF единица — "дюйм". |
|
обводы
|
lines | array of TextLine |
Если параметр includeTextDetails имеет значение true, список распознанных текстовых строк. Максимальное количество возвращаемых строк составляет 300 на страницу. Линии сортируются сверху вниз, слева направо, хотя в некоторых случаях близость обрабатывается с более высоким приоритетом. Так как порядок сортировки зависит от обнаруженного текста, он может изменяться на изображениях и обновлениях версий OCR. Таким образом, бизнес-логика должна быть создана на основе фактического расположения строки вместо порядка. |
TextLine
Объект, представляющий извлеченную текстовую строку.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
текст
|
text | string |
Текстовое содержимое строки. |
|
boundingBox
|
boundingBox | BoundingBox |
Ограничивающий прямоугольник с координатами, указанными относительно левого верхнего левого элемента исходного изображения. Восемь чисел представляют четыре точки, по часовой стрелке из левого верхнего угла относительно ориентации текста. Для изображения координаты (x, y) измеряются в пикселях. Для PDF координаты (x, y) измеряются в дюймах. |
|
words
|
words | array of TextWord |
Список слов в текстовой строке. |
TextWord
Объект, представляющий слово.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
текст
|
text | string |
Текстовое содержимое слова. |
|
boundingBox
|
boundingBox | BoundingBox |
Ограничивающий прямоугольник с координатами, указанными относительно левого верхнего левого элемента исходного изображения. Восемь чисел представляют четыре точки, по часовой стрелке из левого верхнего угла относительно ориентации текста. Для изображения координаты (x, y) измеряются в пикселях. Для PDF координаты (x, y) измеряются в дюймах. |
|
уверенность
|
confidence | Confidence |
Значение достоверности. |
BoundingBox
Ограничивающий прямоугольник с координатами, указанными относительно левого верхнего левого элемента исходного изображения. Восемь чисел представляют четыре точки, по часовой стрелке из левого верхнего угла относительно ориентации текста. Для изображения координаты (x, y) измеряются в пикселях. Для PDF координаты (x, y) измеряются в дюймах.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
float |
PageResult
Извлекается информация из одной страницы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Номер страницы. |
|
clusterId
|
clusterId | integer |
Идентификатор кластера. |
|
Пары keyValue
|
keyValuePairs | array of KeyValuePair |
Список пар "ключ-значение", извлеченных на странице. |
|
tables
|
tables | array of DataTable |
Список таблиц данных, извлеченных на странице. |
KeyValuePair
Сведения о извлеченной паре "ключ-значение".
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
label
|
label | string |
Определяемая пользователем метка для записи пары "ключ-значение". |
|
key
|
key | KeyValueElement |
Сведения о извлеченном ключе или значении в паре "ключ-значение". |
|
value
|
value | KeyValueElement |
Сведения о извлеченном ключе или значении в паре "ключ-значение". |
|
уверенность
|
confidence | Confidence |
Значение достоверности. |
KeyValueElement
Сведения о извлеченном ключе или значении в паре "ключ-значение".
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
текст
|
text | string |
Текстовое содержимое ключа или значения. |
|
boundingBox
|
boundingBox | BoundingBox |
Ограничивающий прямоугольник с координатами, указанными относительно левого верхнего левого элемента исходного изображения. Восемь чисел представляют четыре точки, по часовой стрелке из левого верхнего угла относительно ориентации текста. Для изображения координаты (x, y) измеряются в пикселях. Для PDF координаты (x, y) измеряются в дюймах. |
|
азы
|
elements | array of ElementReference |
Если параметр includeTextDetails имеет значение true, список ссылок на текстовые элементы, составляющие этот ключ или значение. |
ElementReference
DataTable
Сведения о извлеченной таблице, содержащейся на странице.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Строк
|
rows | integer |
Количество строк. |
|
columns
|
columns | integer |
Количество столбцов. |
|
Клетки
|
cells | array of DataTableCell |
Список ячеек, содержащихся в таблице. |
DataTableCell
Сведения о извлеченной ячейке в таблице.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
rowIndex
|
rowIndex | integer |
Индекс строки ячейки. |
|
columnIndex
|
columnIndex | integer |
Индекс столбца ячейки. |
|
Функция rowSpan
|
rowSpan | integer |
Количество строк, охватываемых этой ячейкой. |
|
columnSpan
|
columnSpan | integer |
Число столбцов, охватываемых этой ячейкой. |
|
текст
|
text | string |
Текстовое содержимое ячейки. |
|
boundingBox
|
boundingBox | BoundingBox |
Ограничивающий прямоугольник с координатами, указанными относительно левого верхнего левого элемента исходного изображения. Восемь чисел представляют четыре точки, по часовой стрелке из левого верхнего угла относительно ориентации текста. Для изображения координаты (x, y) измеряются в пикселях. Для PDF координаты (x, y) измеряются в дюймах. |
|
азы
|
elements | array of ElementReference |
Если параметр includeTextDetails имеет значение true, список ссылок на текстовые элементы, составляющие эту ячейку таблицы. |
|
isHeader
|
isHeader | boolean |
Возвращается, если текущая ячейка является ячейкой заголовка. |
|
isFooter
|
isFooter | boolean |
Возвращает значение, если текущая ячейка нижнего колонтитула. |
InvoiceDocumentResult
Набор извлеченных полей, соответствующих входной документу.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
docType
|
docType | string |
Тип документа. |
|
pageRange
|
pageRange | array of integer |
Первый и последний номер страницы, где найден документ. |
|
столбцов
|
fields | InvoiceFields |
Поля счета для 2.1. |
BusinessCardDocumentResult
Набор извлеченных полей, соответствующих входной документу.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
docType
|
docType | string |
Тип документа. |
|
pageRange
|
pageRange | array of integer |
Первый и последний номер страницы, где найден документ. |
|
столбцов
|
fields | BusinessCardFields |
Поля BusinessCard для версии 2.1. |
CustomFormsDocumentResult
Набор извлеченных полей, соответствующих входной документу.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
docType
|
docType | string |
Тип документа. |
|
pageRange
|
pageRange | array of integer |
Первый и последний номер страницы, где найден документ. |
|
Fields
|
_fields | array of CustomFormsFields |
Массив полей со свойствами fieldName и fieldValue. |
ReceiptDocumentResult
Набор извлеченных полей, соответствующих входной документу.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
docType
|
docType | string |
Тип документа. |
|
pageRange
|
pageRange | array of integer |
Первый и последний номер страницы, где найден документ. |
|
столбцов
|
fields | ReceiptFields |
Квитанции для 2.1. |
IdDocumentResult
Набор извлеченных полей, соответствующих входной документу.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
docType
|
docType | string |
Тип документа. |
|
pageRange
|
pageRange | array of integer |
Первый и последний номер страницы, где найден документ. |
|
столбцов
|
fields | IdFields |
Поля документа идентификатора для версии 2.1. |
CustomFormsFields
Настраиваемые поля формы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя поля
|
fieldName | string | |
|
Значение поля
|
fieldValue | FieldValue |
Прогнозируемый объект значения поля. |
InvoiceFields
Поля счета для 2.1.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сумма из-за суммы (текст)
|
AmountDue.text | string |
Возвращает сумму по счету, как записано в счете. |
|
Сумма из-за суммы (число)
|
AmountDue.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Достоверность суммы в счете
|
AmountDue.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адрес выставления счетов
|
BillingAddress.text | string | |
|
Достоверность адреса выставления счетов
|
BillingAddress.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Получатель адреса выставления счетов
|
BillingAddressRecipient.text | string | |
|
Доверие получателя адреса выставления счетов
|
BillingAddressRecipient.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адрес клиента
|
CustomerAddress.text | string | |
|
Уверенность в адресе клиента
|
CustomerAddress.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Получатель адреса клиента
|
CustomerAddressRecipient.text | string | |
|
Доверие получателя адреса клиента
|
CustomerAddressRecipient.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Идентификатор клиента
|
CustomerId.text | string | |
|
Достоверность идентификатора клиента
|
CustomerId.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Название клиента
|
CustomerName.text | string | |
|
Достоверность имени клиента
|
CustomerName.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата выполнения (текст)
|
DueDate.text | string |
Возвращает дату выполнения, как записано в счете. |
|
Дата выполнения (дата)
|
DueDate.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность даты выполнения
|
DueDate.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата счета (текст)
|
InvoiceDate.text | string |
Возвращает дату счета, как записано в счете. |
|
Дата счета (дата)
|
InvoiceDate.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность даты счета
|
InvoiceDate.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Номер счета
|
InvoiceId.text | string | |
|
Достоверность идентификатора счета
|
InvoiceId.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Итог счета (текст)
|
InvoiceTotal.text | string |
Возвращает общую сумму счета, как записано в счете. |
|
Итог счета (номер)
|
InvoiceTotal.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Достоверность суммы счета
|
InvoiceTotal.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Предыдущий неоплаченный баланс (текст)
|
PreviousUnpaidBalance.text | string |
Возвращает предыдущий неоплаченный баланс, как указано в счете. |
|
Предыдущий неоплаченный баланс (число)
|
PreviousUnpaidBalance.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Достоверность предыдущего неоплачиваемого баланса
|
PreviousUnpaidBalance.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Заказ на покупку
|
PurchaseOrder.text | string | |
|
Достоверность заказа на покупку
|
PurchaseOrder.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адрес перевода
|
RemittanceAddress.text | string | |
|
Достоверность адреса денежных переводов
|
RemittanceAddress.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Получатель адреса перевода
|
RemittanceAddressRecipient.text | string | |
|
Доверие получателя адреса перевода денежных средств
|
RemittanceAddressRecipient.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адрес службы
|
ServiceAddress.text | string | |
|
Достоверность адреса службы
|
ServiceAddress.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Получатель адреса службы
|
ServiceAddressRecipient.text | string | |
|
Доверие получателя адреса службы
|
ServiceAddressRecipient.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата окончания службы (текст)
|
ServiceEndDate.text | string |
Возвращает дату окончания службы, как записано в счете. |
|
Дата окончания службы (дата)
|
ServiceEndDate.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность даты окончания службы
|
ServiceEndDate.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата начала службы (текст)
|
ServiceStartDate.text | string |
Возвращает дату начала службы, как записано в счете. |
|
Дата начала службы (дата)
|
ServiceStartDate.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность даты начала службы
|
ServiceStartDate.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адрес доставки
|
ShippingAddress.text | string | |
|
Достоверность адреса доставки
|
ShippingAddress.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Получатель адреса доставки
|
ShippingAddressRecipient.text | string | |
|
Доверие получателя адреса доставки
|
ShippingAddressRecipient.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Промежуточный итог (текст)
|
SubTotal.text | string |
Возвращает промежуточный итог, как записано в счете. |
|
Промежуточный итог (число)
|
SubTotal.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Достоверность промежуточных итогов
|
SubTotal.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Общий налог (текст)
|
TotalTax.text | string |
Возвращает общий налог, как указано в счете. |
|
Общий налог (номер)
|
TotalTax.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Достоверность общего налога
|
TotalTax.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адрес поставщика
|
VendorAddress.text | string | |
|
Достоверность адреса поставщика
|
VendorAddress.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Получатель адреса поставщика
|
VendorAddressRecipient.text | string | |
|
Доверие получателя адреса поставщика
|
VendorAddressRecipient.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Имя поставщика
|
VendorName.text | string | |
|
Достоверность имени поставщика
|
VendorName.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Товары
|
Items.valueArray | array of object |
Массив элементов строки |
|
Сумма (текст)
|
Items.valueArray.valueObject.Amount.text | string |
Возвращает сумму, записанную в счете. |
|
Сумма (число)
|
Items.valueArray.valueObject.Amount.valueNumber | number |
Форматируется как число. Пример: 12. |
|
Достоверность суммы
|
Items.valueArray.valueObject.Amount.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Description
|
Items.valueArray.valueObject.Description.text | string | |
|
Достоверность описания
|
Items.valueArray.valueObject.Description.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Количество (текст)
|
Items.valueArray.valueObject.Quantity.text | string |
Возвращает количество, записанное в счете. |
|
Количество (число)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Форматируется как число. Пример: 12. |
|
Достоверность количества
|
Items.valueArray.valueObject.Quantity.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Цена единицы (текст)
|
Items.valueArray.valueObject.UnitPrice.text | string |
Возвращает цену единицы, как записано в счете. |
|
Цена за единицу (номер)
|
Items.valueArray.valueObject.UnitPrice.valueNumber | number |
Форматируется как число. Пример: 12. |
|
Достоверность цены на единицу
|
Items.valueArray.valueObject.UnitPrice.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Код продукта
|
Items.valueArray.valueObject.ProductCode.text | string | |
|
Достоверность кода продукта
|
Items.valueArray.valueObject.ProductCode.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Единица
|
Items.valueArray.valueObject.Unit.text | string | |
|
Достоверность единицы
|
Items.valueArray.valueObject.Unit.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата (текст)
|
Items.valueArray.valueObject.Date.text | string |
Возвращает дату, как записано в счете. |
|
Дата (дата)
|
Items.valueArray.valueObject.Date.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность даты
|
Items.valueArray.valueObject.Date.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Налог (текст)
|
Items.valueArray.valueObject.Tax.text | string |
Возвращает налог, как указано в счете. |
|
Налог (номер)
|
Items.valueArray.valueObject.Tax.valueNumber | number |
Форматируется как число. Пример: 12. |
|
Доверие к налогу
|
Items.valueArray.valueObject.Tax.confidence | float |
Насколько уверена модель в своем прогнозе. |
BusinessCardFields
Поля BusinessCard для версии 2.1.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имена контактов
|
ContactNames.valueArray | array of object |
Массив имен контактов |
|
Имя (первое имя)
|
ContactNames.valueArray.valueObject.FirstName.text | string | |
|
Достоверность имени
|
ContactNames.valueArray.valueObject.FirstName.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Фамилия
|
ContactNames.valueArray.valueObject.LastName.text | string | |
|
Достоверность фамилии
|
ContactNames.valueArray.valueObject.LastName.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Имена компаний
|
CompanyNames.valueArray | array of object |
Массив имен компаний |
|
Название компании
|
CompanyNames.valueArray.text | string | |
|
Достоверность имени компании
|
CompanyNames.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Departments
|
Departments.valueArray | array of object |
Массив отделов |
|
Отдел
|
Departments.valueArray.text | string | |
|
Доверие отдела
|
Departments.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Названия заданий
|
JobTitles.valueArray | array of object |
Массив заголовков заданий |
|
Название задания
|
JobTitles.valueArray.text | string | |
|
Достоверность названия задания
|
JobTitles.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Сообщения электронной почты
|
Emails.valueArray | array of object |
Массив сообщений электронной почты |
|
Адрес электронной почты
|
Emails.valueArray.text | string | |
|
Достоверность электронной почты
|
Emails.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Веб-сайты
|
Websites.valueArray | array of object |
Массив веб-сайтов |
|
Веб-сайт
|
Websites.valueArray.text | string | |
|
Достоверность веб-сайта
|
Websites.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адреса
|
Addresses.valueArray | array of object |
Массив адресов |
|
Address
|
Addresses.valueArray.text | string | |
|
Достоверность адреса
|
Addresses.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Мобильные телефоны
|
MobilePhones.valueArray | array of object |
Массив мобильных телефонов |
|
Мобильный телефон
|
MobilePhones.valueArray.text | string | |
|
Достоверность мобильного телефона
|
MobilePhones.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
факсы;
|
Faxes.valueArray | array of object |
Массив факсов |
|
Факс
|
Faxes.valueArray.text | string | |
|
Достоверность факса
|
Faxes.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Рабочие телефоны
|
WorkPhones.valueArray | array of object |
Массив рабочих телефонов |
|
Рабочий телефон
|
WorkPhones.valueArray.text | string | |
|
Уверенность в работе телефона
|
WorkPhones.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Другие телефоны
|
OtherPhones.valueArray | array of object |
Массив других телефонов |
|
Другой телефон
|
OtherPhones.valueArray.text | string | |
|
Доверие к другому телефону
|
OtherPhones.valueArray.confidence | float |
Насколько уверена модель в своем прогнозе. |
ReceiptFields
Квитанции для 2.1.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип чека
|
ReceiptType.text | string | |
|
Достоверность типа квитанции
|
ReceiptType.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Имя продавца
|
MerchantName.text | string | |
|
Достоверность имени продавца
|
MerchantName.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Номер телефона продавца
|
MerchantPhoneNumber.text | string | |
|
Достоверность номера телефона продавца
|
MerchantPhoneNumber.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Адрес продавца
|
MerchantAddress.text | string | |
|
Достоверность адреса продавца
|
MerchantAddress.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата транзакции (текст)
|
TransactionDate.text | string |
Возвращает дату транзакции, как записано в счете. |
|
Дата транзакции (дата)
|
TransactionDate.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность даты транзакции
|
TransactionDate.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Время транзакции (текст)
|
TransactionTime.text | string |
Возвращает время транзакции, как записано в счете. |
|
Время транзакции (время)
|
TransactionTime.valueDate | time |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность времени транзакции
|
TransactionTime.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Всего (текст)
|
Total.text | string |
Возвращает общую сумму, как записано в счете. |
|
Общее (число)
|
Total.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Уверенность в общем объеме
|
Total.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Промежуточный итог (текст)
|
Subtotal.text | string |
Возвращает промежуточный итог, как записано в счете. |
|
Промежуточный итог (число)
|
Subtotal.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Достоверность промежуточных итогов
|
Subtotal.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Налог (текст)
|
Tax.text | string |
Возвращает налог, как указано в счете. |
|
Налог (номер)
|
Tax.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Доверие к налогу
|
Tax.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Совет (текст)
|
Tip.text | string |
Возвращает подсказку, как записано в счете. |
|
Совет (число)
|
Tip.valueNumber | number |
Форматируется как число. Пример: 1234.98. |
|
Уверенность в совете
|
Tip.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Товары
|
Items.valueArray | array of object |
Массив элементов строки |
|
Имя
|
Items.valueArray.valueObject.Name.text | string | |
|
Достоверность имени
|
Items.valueArray.valueObject.Name.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Количество (текст)
|
Items.valueArray.valueObject.Quantity.text | string |
Возвращает количество, записанное в счете. |
|
Количество (число)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Форматируется как число. Пример: 12. |
|
Достоверность количества
|
Items.valueArray.valueObject.Quantity.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Цена (текст)
|
Items.valueArray.valueObject.Price.text | string |
Возвращает цену, как записано в счете. |
|
Цена (номер)
|
Items.valueArray.valueObject.Price.valueNumber | number |
Форматируется как число. Пример: 12. |
|
Достоверность цены
|
Items.valueArray.valueObject.Price.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Общая цена (текст)
|
Items.valueArray.valueObject.TotalPrice.text | string |
Возвращает общую цену, как указано в счете. |
|
Общая цена (номер)
|
Items.valueArray.valueObject.TotalPrice.valueNumber | number |
Форматируется как число. Пример: 12. |
|
Достоверность общей цены
|
Items.valueArray.valueObject.TotalPrice.confidence | float |
Насколько уверена модель в своем прогнозе. |
IdFields
Поля документа идентификатора для версии 2.1.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Регион страны
|
CountryRegion.valueCountryRegion | string | |
|
Доверие к региону страны
|
CountryRegion.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата окончания срока действия
|
DateOfExpiration.text | string |
Возвращает дату окончания срока действия, как записано в счете. |
|
Дата окончания срока действия (дата)
|
DateOfExpiration.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность срока действия
|
DateOfExpiration.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Дата рождения (текст)
|
DateOfBirth.text | string |
Возвращает дату рождения, как записано в счете. |
|
Дата рождения (дата)
|
DateOfBirth.valueDate | date |
Форматируется как дата. Пример: 2019-05-31. |
|
Достоверность даты рождения
|
DateOfBirth.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Номер документа
|
DocumentNumber.text | string | |
|
Достоверность номера документа
|
DocumentNumber.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Имя (первое имя)
|
FirstName.text | string | |
|
Достоверность имени
|
FirstName.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Фамилия
|
LastName.text | string | |
|
Достоверность фамилии
|
LastName.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Nationality
|
Nationality.valueCountryRegion | string | |
|
Уверенность в национальности
|
Nationality.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Sex
|
Sex.text | string | |
|
Уверенность в сексе
|
Sex.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Зоны, доступные для чтения компьютера
|
MachineReadableZone.text | string | |
|
Достоверность зоны, доступной для чтения компьютера
|
MachineReadableZone.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Тип документа
|
DocumentType.text | string | |
|
Достоверность типа документа
|
DocumentType.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Address
|
Address.text | string | |
|
Достоверность адреса
|
Address.confidence | float |
Насколько уверена модель в своем прогнозе. |
|
Регион
|
Region.text | string | |
|
Достоверность региона
|
Region.confidence | float |
Насколько уверена модель в своем прогнозе. |
FieldValue
Прогнозируемый объект значения поля.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | FieldValueType |
Семантический тип данных значения поля. |
|
valueString
|
valueString | string |
Строковое значение. |
|
valueDate
|
valueDate | date-time |
Значение даты. |
|
valueTime
|
valueTime | date-time |
Значение времени. |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Значение номера телефона. |
|
valueNumber
|
valueNumber | number |
Значение с плавающей запятой. |
|
valueInteger
|
valueInteger | integer |
Целочисленное значение. |
|
текст
|
text | string | |
|
boundingBox
|
boundingBox | BoundingBox |
Ограничивающий прямоугольник с координатами, указанными относительно левого верхнего левого элемента исходного изображения. Восемь чисел представляют четыре точки, по часовой стрелке из левого верхнего угла относительно ориентации текста. Для изображения координаты (x, y) измеряются в пикселях. Для PDF координаты (x, y) измеряются в дюймах. |
|
уверенность
|
confidence | Confidence |
Значение достоверности. |
|
азы
|
elements | array of ElementReference |
Если параметр includeTextDetails имеет значение true, список ссылок на текстовые элементы, составляющие это поле. |
|
page
|
page | integer |
Номер страницы на основе 1 в входном документе. |
FieldValueType
Достоверность
ApiVersion_V30
AnalyzeResultOperation_V30
Состояние и результат операции анализа.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | string |
Состояние операции. |
|
createdDateTime
|
createdDateTime | date-time |
Дата и время (UTC) при отправке операции анализа. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time |
Дата и время (UTC) при последнем обновлении состояния. |
|
ошибка
|
error | Error_V30 |
Сведения об ошибке. |
|
analyzeResult
|
analyzeResult | AnalyzeResult_V30 |
Результат анализа документов. |
AnalyzeResult_V30
Результат анализа документов.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
apiVersion
|
apiVersion | ApiVersion_V30 |
Версия API. |
|
modelId
|
modelId | ModelId_V30 |
Уникальное имя модели. |
|
stringIndexType
|
stringIndexType | StringIndexType_V30 |
Метод, используемый для вычисления смещения и длины строки. |
|
содержимое
|
content | string |
Объединение строковых представлений всех текстовых и визуальных элементов в порядке чтения. |
|
contentFormat
|
contentFormat | ContentFormat_V40 |
Формат содержимого в проанализированном результате. |
|
pages
|
pages | array of DocumentPage_V30 |
Проанализированные страницы. |
|
Пунктах
|
paragraphs | array of DocumentParagraph_V30 |
Извлеченные абзацы. |
|
tables
|
tables | array of DocumentTable_V30 |
Извлеченные таблицы. |
|
цифра
|
figures | array of DocumentFigure_V40 |
Извлеченные цифры. |
|
сортовое железо
|
sections | array of DocumentSection_V40 |
Извлеченные разделы. |
|
Пары keyValue
|
keyValuePairs | array of DocumentKeyValuePair_V30 |
Извлеченные пары "ключ-значение". |
|
entities
|
entities | array of DocumentEntity_V30 |
Извлеченные сущности. |
|
Стили
|
styles | array of DocumentStyle_V30 |
Извлеченные стили шрифтов. |
|
Языки
|
languages | array of DocumentLanguage_V30 |
Обнаруженные языки. |
|
Документы
|
documents | array of Document_V30 |
Извлеченные документы. |
|
Предупреждения
|
warnings | array of Warning_V40 |
Список предупреждений. |
DocumentPage_V30
Элементы содержимого и макета, извлеченные на странице из входных данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
добрый
|
kind | string |
Вид страницы документа. |
|
pageNumber
|
pageNumber | integer |
Номер страницы на основе 1 в входном документе. |
|
угол
|
angle | number |
Общая ориентация содержимого в часовом направлении, измеряемая в градусах между (-180, 180]. |
|
Ширина
|
width | number |
Ширина изображения/PDF в пикселях/дюймах соответственно. |
|
height
|
height | number |
Высота изображения/PDF в пикселях/дюймах соответственно. |
|
единица
|
unit | string |
Единица, используемая свойствами ширины, высоты и многоугольника. Для изображений единица — "пиксель". Для PDF единица — "дюйм". |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение страницы в сцепленном содержимом порядка чтения. |
|
words
|
words | array of DocumentWord_V30 |
Извлеченные слова из страницы. |
|
selectionMarks
|
selectionMarks | array of DocumentSelectionMark_V30 |
Извлеченные метки выделения на странице. |
|
images
|
images | array of DocumentImage_V30 |
Извлеченные изображения на странице. |
|
обводы
|
lines | array of DocumentLine_V30 |
Извлеченные строки из страницы, потенциально содержащие текстовые и визуальные элементы. |
|
штрихкоды
|
barcodes | array of DocumentBarcode_V31 |
Извлеченные штрихкоды на странице. |
|
formulas
|
formulas | array of DocumentFormula_V31 |
Извлеченные формулы на странице. |
DocumentWord_V30
Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
содержимое
|
content | string |
Текстовое содержимое слова. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
|
span
|
span | DocumentSpan_V30 |
Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
DocumentSelectionMark_V30
Объект метки выбора, представляющий флажки, переключатели и другие элементы, указывающие на выделение.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
государство
|
state | DocumentSelectionMarkState_V30 |
Состояние знака выделения. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
|
span
|
span | DocumentSpan_V30 |
Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
DocumentImage_V30
Объект изображения, обнаруженный на странице.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
polygon
|
polygon | BoundingPolygon_V30 |
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
|
span
|
span | DocumentSpan_V30 |
Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина. |
|
pageRef
|
pageRef | integer |
0-й индекс глобального массива страниц, содержащего содержимое изображения. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
DocumentSelectionMarkState_V30
DocumentStyle_V30
Объект, представляющий наблюдаемые стили текста.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
backgroundColor
|
backgroundColor | string |
Цвет фона в #rrggbb шестнадцатеричном формате.. |
|
color
|
color | string |
Цвет переднего плана в #rrggbb шестнадцатеричном формате. |
|
fontStyle
|
fontStyle | string |
Стиль шрифта. |
|
fontWeight
|
fontWeight | string |
Вес шрифта. |
|
isHandwritten
|
isHandwritten | boolean |
Является рукописным текстом содержимого. |
|
similarFontFamily
|
similarFontFamily | string |
Визуально наиболее похожий шрифт из набора поддерживаемых семейств шрифтов с резервными шрифтами после соглашения CSS (например, Arial, sans-serif). |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение текстовых элементов в сцепленном содержимом, к который применяется стиль. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
DocumentLanguage_V30
Объект, представляющий обнаруженный язык для заданного диапазона текста.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
местность
|
locale | string |
Обнаруженный язык. Значение может содержать код языка ISO 639-1 (например, en, fr) или тег языка BCP 47 (например, "zh-Hans"). |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение текстовых элементов в сцепленном содержимом, к который применяется язык. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
DocumentLine_V30
Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и знаки выделения.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
содержимое
|
content | string |
Сцепленное содержимое содержащихся элементов в порядке чтения. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение строки в сцепленном содержимом порядка чтения. |
DocumentParagraph_V30
Объект абзаца, состоящий с смежными линиями, как правило, с общим выравниванием и интервалами.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
роль
|
role | string |
Семантическая роль абзаца. |
|
содержимое
|
content | string |
Сцепленное содержимое абзаца в порядке чтения. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие регионы, охватывающие абзац. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение абзаца в сцепленном содержимом порядка чтения. |
DocumentTable_V30
Объект таблицы, состоящий из ячеек таблицы, расположенных в прямоугольном макете.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
rowCount
|
rowCount | integer |
Количество строк в таблице. |
|
columnCount
|
columnCount | integer |
Количество столбцов в таблице. |
|
Клетки
|
cells | array of DocumentTableCell_V30 |
Ячейки, содержащиеся в таблице. |
|
заголовок
|
caption | DocumentCaption_V30 |
Объект, представляющий расположение и содержимое заголовка таблицы. |
|
Сноски
|
footnotes | array of DocumentFootnote_V30 |
Сноски, связанные с таблицей. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие таблицу. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение таблицы в сцепленном содержимом порядка чтения. |
DocumentTableCell_V30
Объект, представляющий расположение и содержимое ячейки таблицы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
добрый
|
kind | string |
Тип ячейки таблицы. |
|
rowIndex
|
rowIndex | integer |
Индекс строки ячейки. |
|
columnIndex
|
columnIndex | integer |
Индекс столбца ячейки. |
|
Функция rowSpan
|
rowSpan | integer |
Количество строк, охватываемых этой ячейкой. |
|
columnSpan
|
columnSpan | integer |
Число столбцов, охватываемых этой ячейкой. |
|
содержимое
|
content | string |
Сцепленное содержимое ячейки таблицы в порядке чтения. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие ячейку таблицы. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение ячейки таблицы в сцепленном содержимом порядка чтения. |
DocumentCaption_V30
Объект, представляющий расположение и содержимое заголовка таблицы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
содержимое
|
content | string |
Содержимое заголовка таблицы. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие заголовок таблицы. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение заголовка таблицы в сцепленном содержимом порядка чтения. |
DocumentFootnote_V30
Объект, представляющий расположение и содержимое сноски таблицы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
содержимое
|
content | string |
Содержимое сноски таблицы. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие сноску таблицы. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение сноски таблицы в сложенном порядке чтения. |
DocumentKeyValuePair_V30
Объект, представляющий поле формы с отдельной меткой поля (ключом) и значением поля (может быть пустым).
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
key
|
key | DocumentKeyValueElement_V30 |
Объект, представляющий ключ поля или значение в паре "ключ-значение". |
|
value
|
value | DocumentKeyValueElement_V30 |
Объект, представляющий ключ поля или значение в паре "ключ-значение". |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
DocumentKeyValueElement_V30
Объект, представляющий ключ поля или значение в паре "ключ-значение".
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
содержимое
|
content | string |
Сцепленное содержимое элемента key-value в порядке чтения. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие элемент key-value. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение элемента key-value в сцепленном содержимом порядка чтения. |
DocumentEntity_V30
Объект, представляющий различные категории сущностей.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
категория
|
category | string |
Тип сущности. |
|
Подкатегории
|
subCategory | string |
Подтип сущности. |
|
содержимое
|
content | string |
Содержимое сущности. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие сущность. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение сущности в сцепленном содержимом порядка чтения. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
DocumentBarcode_V31
Объект штрихкода.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
|
добрый
|
kind | string |
Вид штрихкода. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
|
span
|
span | DocumentSpan_V30 |
Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина. |
|
value
|
value | string |
Значение штрихкода |
DocumentFormula_V31
Объект формулы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
|
добрый
|
kind | string |
Тип формулы. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
|
span
|
span | DocumentSpan_V30 |
Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина. |
|
value
|
value | string |
Выражение LaTex, описывающее формулу. |
DocumentFigure_V40
Объект, представляющий фигуру в документе.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие фигуру. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение рисунка в сцепленном содержимом порядка чтения. |
|
азы
|
elements | array of DocumentElement_V40 |
Дочерние элементы фигуры, за исключением подписей или сносок. |
|
заголовок
|
caption | DocumentCaption_V30 |
Объект, представляющий расположение и содержимое заголовка таблицы. |
|
Сноски
|
footnotes | array of DocumentFootnote_V30 |
Список сносок, связанных с рисунком. |
|
id
|
id | string |
Идентификатор рисунка. |
DocumentSection_V40
Объект, представляющий раздел в документе.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение раздела в сцепленном содержимом порядка чтения. |
|
азы
|
elements | array of DocumentElement_V40 |
Дочерние элементы раздела. |
DocumentElement_V40
Указатель JSON, ссылающийся на элемент документа, например абзац, таблица, раздел и т. д.
Указатель JSON, ссылающийся на элемент документа, например абзац, таблица, раздел и т. д.
Warning_V40
Объект ошибки.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код
|
code | string |
Один из определяемых сервером набор кодов предупреждений. |
|
сообщение
|
message | string |
Доступное для чтения представление предупреждения. |
|
target
|
target | string |
Целевой объект ошибки. |
ContentFormat_V40
Формат содержимого в проанализированном результате.
Формат содержимого в проанализированном результате.
Document_V30
Объект, описывающий расположение и семантическое содержимое документа.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
docType
|
docType | DocType_V30 |
Имя типа документа. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие документ. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение документа в порядке чтения сцепленного содержимого. |
|
столбцов
|
fields | object |
Словарь именованных значений полей. |
|
Fields
|
_fields | array of DocumentFieldNameValue_V30 |
Массив полей со свойствами fieldName и fieldValue. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
BoundingPolygon_V30
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
number |
BoundingRegion_V30
Ограничивающий многоугольник на определенной странице входных данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
pageNumber
|
pageNumber | integer |
Номер страницы на основе 1, содержащий ограничивающий регион. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Ограничивающий многоугольник с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
DocumentFieldType_V30
DocumentFieldNameValue_V30
Объект поля документа с именем поля и его значением.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя поля
|
fieldName | string | |
|
fieldValue
|
fieldValue | DocumentField_V30 |
Объект, представляющий содержимое и расположение значения поля. |
DocumentField_V30
Объект, представляющий содержимое и расположение значения поля.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | DocumentFieldType_V30 |
Семантический тип данных значения поля. |
|
valueString
|
valueString | string |
Строковое значение. |
|
valueDate
|
valueDate | date |
Значение даты в формате YYY-MM-DD (ISO 8601). |
|
valueTime
|
valueTime | time |
Значение времени в формате hh:mm:ss (ISO 8601). |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Значение номера телефона в формате E.164 (например, +19876543210). |
|
valueNumber
|
valueNumber | number |
Значение с плавающей запятой. |
|
valueInteger
|
valueInteger | integer |
Целочисленное значение. |
|
valueSelectionMark
|
valueSelectionMark | DocumentSelectionMarkState_V30 |
Состояние знака выделения. |
|
valueSignature
|
valueSignature | string |
Наличие подписи. |
|
valueCountryRegion
|
valueCountryRegion | string |
3-буквенный код страны (ISO 3166-1 alpha-3). |
|
valueCurrency
|
valueCurrency | CurrencyValue_V30 |
Значение поля валюты. |
|
valueAddress
|
valueAddress | AddressValue_V30 |
Значение поля адреса. |
|
valueBoolean
|
valueBoolean | boolean |
Логическое значение. |
|
содержимое
|
content | string |
Содержимое поля. |
|
ограничивающиеregions
|
boundingRegions | array of BoundingRegion_V30 |
Ограничивающие области, охватывающие поле. |
|
spans
|
spans | array of DocumentSpan_V30 |
Расположение поля в сцепленном содержимом порядка чтения. |
|
уверенность
|
confidence | Confidence_V30 |
Достоверность прогнозирования. |
Confidence_V30
DocType_V30
DocumentSpan_V30
Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
offset
|
offset | integer |
Отсчитываемый от нуля индекс содержимого, представленный диапазоном. |
|
length
|
length | integer |
Количество символов в содержимом, представленных диапазоном. |
StringIndexType_V30
Метод, используемый для вычисления смещения и длины строки.
Метод, используемый для вычисления смещения и длины строки.
ModelId_V30
Error_V30
Сведения об ошибке.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код
|
code | string |
Код ошибки. |
|
сообщение
|
message | string |
Сообщение об ошибке. |
|
target
|
target | string |
Цель ошибки. |
|
details
|
details | array of InnerError_V30 |
Список подробных ошибок. |
|
innererror
|
innererror | InnerError_V30 |
Подробная ошибка. |
InnerError_V30
Подробная ошибка.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
код
|
code | string |
Код ошибки. |
|
сообщение
|
message | string |
Сообщение об ошибке. |
CurrencyValue_V30
Значение поля валюты.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
количество
|
amount | double |
Сумма валюты. |
|
Код валюты
|
currencyCode | string |
Разрешенный код валюты (ISO 4217), если таковой есть. |
|
currencySymbol
|
currencySymbol | string |
Метка символа валюты, если она есть. |
AddressValue_V30
Значение поля адреса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
houseNumber
|
houseNumber | string |
Номер дома или здания. |
|
poBox
|
poBox | string |
Номер почтового ящика. |
|
дорога
|
road | string |
Имя улицы. |
|
city
|
city | string |
Имя города, города, деревни и т. д. |
|
государство
|
state | string |
Административное подразделение первого уровня. |
|
postalCode
|
postalCode | string |
Почтовый индекс, используемый для сортировки почты. |
|
countryRegion
|
countryRegion | string |
Страна или регион. |
|
уличный адрес
|
streetAddress | string |
Адрес уровня улицы, за исключением города, штата, countryRegion и почтового кода. |
|
cityDistrict
|
cityDistrict | string |
Районы или районы в городе, такие как Бруклин в Нью-Йорке или городе Вестминстер в Лондоне. |
|
Дом
|
house | string |
Имя сборки, например World Trade Center. |
|
уровень
|
level | string |
Номер этажа, например 3F. |
|
stateDistrict
|
stateDistrict | string |
Административное подразделение второго уровня, используемое в определенных языковых стандартах. |
|
пригород
|
suburb | string |
Неофициальное название района, как Chinatown. |
|
единица
|
unit | string |
Номер квартиры или офиса. |