Зува DocAI

Внедрение ИИ контрактов в рабочие процессы продукта с помощью Zuva DocAI. Нет необходимости в разработке ИИ с нуля, используйте API DocAI для извлечения информации из ваших контрактов.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка Zuva
URL https://zuva.ai/support/
Адрес электронной почты support@zuva.ai
Метаданные соединителя
Publisher Зува Inc.
Веб-сайт https://zuva.ai/
Политика конфиденциальности https://zuva.ai/privacy/
Категории AI

Этот соединитель позволяет пользователям находить и извлекать сущности, предложения и абзацы из контрактов (и связанных документов), используя лучший в классе ИИ контрактов Zuva. Разработан и обучен, чтобы определить юридические предложения в нескольких отраслях и вариантах использования, этот соединитель предоставляет набор модулей plug-and-play для внедрения ИИ контрактов в рабочие процессы. Этот соединитель поставляется с OCR для чтения документов, а также возможностей классификации и нормализации документов.

Предпосылки

Вам потребуется учетная запись Zuva и токен DocAI. Начните с регистрации бесплатной учетной записи.

Получение учетных данных

Zuva DocAI имеет несколько региональных серверов. Необходимо создать маркер API для определенного региона, который вы хотите использовать.

  1. Создайте и(или) войдите в свою учетную запись в zuva.ai.
  2. Перейдите к консоли DocAI
  3. Выберите регион, который вы хотите использовать.
  4. Скопируйте базовый URL-адрес региона в подключение.
  5. Создайте маркер и скопируйте его для использования в подключении.

Дополнительные сведения о учетных записях и токенах Zuva см. в кратком руководстве по DocAI .

Начало работы с соединителем

Чтобы использовать соединитель Zuva DocAI, необходимо задать поток, аналогичный следующему:

Шаг 1. Получение файла

В целях тестирования можно создать "Мгновенный облачный поток" в Power Automate. Выберите "Вручную активировать поток" и создайте поток. Добавьте входные данные и выберите тип "Файл".

Шаг 2. Отправка файла

Добавьте действие и выберите "Содержимое Submit a file файла" на предыдущем шаге в качестве входных данных.

Примечание. Файл не должен быть преобразован каким-либо образом (т. е. без кодировки Base64). DocAI принимает только необработанные двоичные данные.

Шаг 3. Начало обработки файла

Выберите службу, которую вы хотите использовать, добавив одно из следующих действий:

  • Create Language Classification Request
  • Create Document Classification Request
  • Create Multi-Level Classification Request
  • Create Field Extraction Request
  • Create OCR Request

Каждый из них принимает идентификатор файла (возвращенный из Submit a file действия) в качестве входных данных.

Для извлечения полей также требуются идентификаторы полей в качестве входных данных. Идентификаторы полей можно найти в библиотеке полей (требуется для входа), от тренера ИИ , если вы обучили настраиваемые поля или программно с помощью Get Field List действия.

Шаг 4. Опрос для завершения запроса

Используйте блок (найденный Do Until в разделе Control) и добавьте правильное действие проверки состояния в внутри блока:

  • Get Field Extraction Request Status
  • Get Language Classification Request Status
  • Get Document Classification Request Status
  • Get MLC request Status
  • Get OCR Request Status

Действие Get ____ status принимается в качестве входных данных идентификатора запроса из соответствующего Create ____ Request действия.

Кроме того, необходимо добавить в блок Delay 10 секундDo until, чтобы убедиться, что файл имеет достаточно времени для обработки.

Задайте условие для Do Until блока Is Finished? равным true.

Шаг 4. Получение результатов

Наконец, используйте одно из действий получения результатов, соответствующее запросу, используя идентификатор запроса из исходной операции создания в качестве входных данных:

  • Get Field Extraction Request Text Results
  • Get Language Classification Request Status
  • Get Document Classification Request Status
  • Get MLC request Status
  • Get OCR Results Text
  • Get OCR Results Images

Обратите внимание, что для языка, классификации документов и MLC результаты включаются в ответ состояния.

Возможно, вы хотите проверить документацию DocAI для получения дополнительных сведений о структуре результатов извлечения полей.

Известные проблемы и ограничения

Поля на запрос

В одно Create Field Extraction Request действие может быть включено не более 100 полей.

Пользовательские поля

Соединитель не поддерживает ни одну из конечных точек DocAI, связанных с обучением настраиваемых полей или получение метаданных отдельного поля.

Различия с базовым API

Кроме того, обратите внимание, что функциональные возможности соединителя не соответствуют одному к одному с документацией по базовому API. В частности, соединитель:

  1. Предоставляет дополнительное is_finished логическое значение, которое можно использовать для определения завершения или сбоя запроса.
  2. Все запросы работают с одними файлами, а не пакетами нескольких файлов.

Распространенные ошибки и средства устранения неполадок

Не забудьте отправить необработанный двоичный файл, а не строки в кодировке Base64. Службу OCR можно использовать и проверить, возвращает ли он ожидаемый текст.

Часто задаваемые вопросы

Где можно найти дополнительные сведения о Zuva DocAI?

https://zuva.ai/docai/

Где можно найти дополнительную документацию по Zuva DocAI?

https://zuva.ai/documentation/

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Токен securestring Маркер DocAI True
Базовый URL-адрес струна Например, https://us.app.zuva.ai/api/v2 True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Нормализованные даты

Нормализуйте строку, содержащую одну или несколько дат. Для каждой найденной даты конечная точка возвращает набор целых чисел, представляющих год, месяц и день.
Отправка файла

Отправьте файл в Zuva DocAI.
Получение изображений запросов OCR

Получение изображений из завершенного запроса OCR.
Получение результатов запроса на извлечение полей

Получение текстовых результатов из завершенного запроса на извлечение полей.
Получение состояния запроса MLC

Получение состояния и доступных результатов для существующего запроса MLC.
Получение состояния запроса OCR

Проверьте состояние существующего запроса OCR.
Получение состояния запроса классификации документов

Получение состояния и доступных результатов для существующего запроса на классификацию документов.
Получение состояния запроса классификации языка

Получение состояния и доступных результатов для существующего запроса на классификацию документов.
Получение состояния запроса на извлечение полей

Проверьте состояние существующего запроса на извлечение полей.
Получение списка полей

Получите список всех доступных вам полей.
Получение текста запроса OCR

Получите текст из завершенного запроса OCR.
Создание запроса OCR

Создайте новый запрос для применения OCR к указанному файлу.
Создание запроса классификации документов

Создайте запрос на классификацию указанного документа.
Создание запроса классификации языков

Создайте запрос на язык указанного файла.
Создание запроса на извлечение полей

Создайте новый запрос на извлечение из указанного файла.
Создание запроса на классификацию нескольких уровней

Создайте запрос на многоуровневую классификацию указанного файла.
Удаление файла

Удалите существующий файл из Zuva.

Нормализованные даты

Идентификатор операции:
NormalizeDates

Нормализуйте строку, содержащую одну или несколько дат. Для каждой найденной даты конечная точка возвращает набор целых чисел, представляющих год, месяц и день.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
 text string

Текстовая строка для нормализации.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор запроса
 request_id string

Идентификатор запроса
текст
 text string

Исходный текст, предоставленный.
sha-256
 sha-256 string

Хэш SHA-256 исходного текста.
date
 date array of object

date
Day
 date.day integer

День месяца в виде целого числа.
Месяц
 date.month integer

Месяц представлен как целое число от 1 до 12.
Год
 date.year integer

Год представлен как целое число.

Отправка файла

Идентификатор операции:
SubmitFile

Отправьте файл в Zuva DocAI.

Параметры

Имя Ключ Обязательно Тип Описание
Файл
 File binary

Содержимое двоичного файла или строка обычного текста для отправки. Двоичное содержимое не должно быть закодировано в кодировке Base64.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор файла
 file_id string

Уникальный идентификатор, назначенный Зува для файла.
Тип контента
 attributes.content-type string

Обнаруженный тип контента MIME файла
Expiration
 expiration string

Время удаления файла из DocAI.

Получение изображений запросов OCR

Идентификатор операции:
GetOcrRequestImages

Получение изображений из завершенного запроса OCR.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса OCR
 request_id True string

Уникальный идентификатор существующего запроса OCR, возвращенный CreateOcrRequest.

Возвращаемое значение

ZIP-файл, содержащий каждую страницу документа в виде изображения.

Изображения
binary

Получение результатов запроса на извлечение полей

Идентификатор операции:
GetFieldExtractionRequestResults

Получение текстовых результатов из завершенного запроса на извлечение полей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса извлечения
 request_id True string

Уникальный идентификатор существующего запроса на извлечение, возвращенный CreateExtractionRequest.

Возвращаемое значение

Имя Путь Тип Описание
Results
 results array of object

Массив результатов извлечения поля.
ИД поля
 results.field_id string

Уникальный идентификатор извлеченного поля.
Извлечения
 results.extractions array of object

Массив результатов, извлеченных для этого конкретного поля.
Текст
 results.extractions.text string

Текст, извлеченный для поля.
Диапазоны
 results.extractions.spans array of object

Сведения о расположении текста в документе.
Start
 results.extractions.spans.start integer

Индекс первого символа извлечения в тексте документа.
Конец
 results.extractions.spans.end integer

Индекс последнего символа извлечения в тексте документа.
Start
 results.extractions.spans.pages.start integer

Номер страницы, на котором начинается извлечение.
Конец
 results.extractions.spans.pages.end integer

Номер страницы, на котором заканчивается извлечение.

Получение состояния запроса MLC

Идентификатор операции:
GetMlcRequestStatus

Получение состояния и доступных результатов для существующего запроса MLC.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
 request_id True string

Идентификатор запроса MLC, возвращенный CreateMlcRequest.

Возвращаемое значение

Имя Путь Тип Описание
Состояние запроса MLC
 status string

Состояние запроса (один из "queued", "processing", "complete" или "failed").
Готово?
 is_finished boolean

Логическое значение, указывающее, достиг ли запрос состояния терминала (завершен или завершился сбоем).
Classifications
 classifications array of string

Иерархические классификации документа.

Получение состояния запроса OCR

Идентификатор операции:
GetOcrRequestStatus

Проверьте состояние существующего запроса OCR.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса OCR
 request_id True string

Уникальный идентификатор существующего запроса OCR, возвращенный CreateOcrRequest.

Возвращаемое значение

Имя Путь Тип Описание
Состояние запроса OCR
 status string

Состояние запроса (один из "queued", "processing", "complete" или "failed").
Готово?
 is_finished boolean

Логическое значение, указывающее, достиг ли запрос состояния терминала (завершен или завершился сбоем).

Получение состояния запроса классификации документов

Идентификатор операции:
GetDocumentClassificationRequestStatus

Получение состояния и доступных результатов для существующего запроса на классификацию документов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
 request_id True string

Идентификатор запроса на классификацию документов, возвращенный CreateDocumentClasssificationRequest.

Возвращаемое значение

Имя Путь Тип Описание
Состояние запроса классификации
 status string

Состояние запроса (один из "queued", "processing", "complete" или "failed").
Готово?
 is_finished boolean

Логическое значение, указывающее, достиг ли запрос состояния терминала (завершен или завершился сбоем).
Classification
 classification string

Тип обнаруженного документа.
Контракт?
 is_contract boolean

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

Получение состояния запроса классификации языка

Идентификатор операции:
GetLanguageClassificationRequestStatus

Получение состояния и доступных результатов для существующего запроса на классификацию документов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
 request_id True string

Идентификатор запроса классификации языка, возвращенный CreateLanguageRequest.

Возвращаемое значение

Имя Путь Тип Описание
Состояние запроса языка
 status string

Состояние запроса (один из "queued", "processing", "complete" или "failed").
Готово?
 is_finished boolean

Логическое значение, указывающее, достиг ли запрос состояния терминала (завершен или завершился сбоем).
Language
 language string

Основной обнаруженный язык документа.

Получение состояния запроса на извлечение полей

Идентификатор операции:
GetFieldExtractionRequestStatus

Проверьте состояние существующего запроса на извлечение полей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса извлечения
 request_id True string

Уникальный идентификатор существующего запроса на извлечение, возвращенный CreateExtractionRequest.

Возвращаемое значение

Имя Путь Тип Описание
Состояние запроса на извлечение полей
 status string

Состояние запроса (один из "queued", "processing", "complete" или "failed").
Готово?
 is_finished boolean

Логическое значение, указывающее, достиг ли запрос состояния терминала (завершен или завершился сбоем).

Получение списка полей

Идентификатор операции:
GetFieldList

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

Возвращаемое значение

Имя Путь Тип Описание
array of object
ИД поля
 field_id string

Уникальный идентификатор поля.
Имя
 name string

Имя поля
Description
 description string

Описание поля.
Предвзятость
 bias double

Смещение, используемое базовой моделью машинного обучения.
F-оценка
 f_score double

F-оценка поля, статистическая мера его точности.
Точность
 precision double

Точность поля.
отзыв товара
 recall double

Отзыв поля.
Число документов
 document_count integer

Количество документов, на которые было обучено поле.
Настраивается ли пользователь?
 is_custom boolean

Логическое значение, указывающее, является ли поле настраиваемым.
Обучен?
 is_trained boolean

Логическое значение, указывающее, было ли обучено настраиваемое поле.

Получение текста запроса OCR

Идентификатор операции:
GetOcrRequestText

Получите текст из завершенного запроса OCR.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса OCR
 request_id True string

Уникальный идентификатор существующего запроса OCR, возвращенный CreateOcrRequest.

Возвращаемое значение

Имя Путь Тип Описание
Текст
 text string

Текст OCR документа.

Создание запроса OCR

Идентификатор операции:
CreateOcrRequest

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла
 file_id string

Уникальный идентификатор файла, возвращаемый операцией SubmitFile.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор запроса OCR
 request_id string

Идентификатор, используемый для получения состояния и результатов запроса OCR.

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

Идентификатор операции:
CreateDocumentClassificationRequest

Создайте запрос на классификацию указанного документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла
 file_id string

Уникальный идентификатор файла, возвращаемый операцией SubmitFile.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор запроса классификации
 request_id string

Идентификатор, используемый для получения состояния и результатов этого запроса.

Создание запроса классификации языков

Идентификатор операции:
CreateLanguageClassificationRequest

Создайте запрос на язык указанного файла.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла
 file_id string

Уникальный идентификатор файла, возвращаемый операцией SubmitFile.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор языкового запроса
 request_id string

Идентификатор, используемый для получения состояния и результатов этого запроса.

Создание запроса на извлечение полей

Идентификатор операции:
CreateFieldExtractionRequest

Создайте новый запрос на извлечение из указанного файла.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла
 file_id string

Файл, из который нужно извлечь текст.
Идентификаторы полей
 field_ids array of string

Идентификаторы полей для извлечения.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор запроса на извлечение
 request_id string

Идентификатор, используемый для получения состояния и результатов этого запроса.

Создание запроса на классификацию нескольких уровней

Идентификатор операции:
CreateMlcRequest

Создайте запрос на многоуровневую классификацию указанного файла.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла
 file_id string

Уникальный идентификатор файла, возвращаемый операцией SubmitFile.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор запроса MLC
 request_id string

Идентификатор, используемый для получения состояния и результатов этого запроса.

Удаление файла

Идентификатор операции:
DeleteFile

Удалите существующий файл из Zuva.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла
 file_id True string

Идентификатор файла для удаления.

Возвращаемое значение

response
string

Определения

струна

Это базовый тип данных string.

бинарный

Это базовый тип данных binary.