AIForged (предварительная версия)

AIForged — это интеллектуальное решение для обработки документов для сложных проблем. AIForged может автоматизировать обработку и извлечение структурированных данных из неструктурированных изображений. Соединитель обеспечивает интеграцию и автоматизацию извлечения документов intellegent с AIForged

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

Услуга	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)

Контакт
Имя	AIForged
URL	https://www.aiforged.com
Адрес электронной почты	support@aiforged.com

Метаданные соединителя
Publisher	Larc AI (PTY) Ltd
Веб-сайт	https://www.aiforged.com
Политика конфиденциальности	https://portal.aiforged.com/privacypolicy.html
Категории	Искусственный интеллект; Содержимое и файлы

AIForged — это облачное решение интеллектуальной обработки документов для решения сложных проблем извлечения документов. Платформа AIForged легко интегрирует несколько служб в одну модель из ведущих в отрасли служб ИИ, таких как Microsoft, Google, Amazon, ABBYY, что дает возможность использовать эти службы в тандеме для оптимальных результатов. Интеллектуальная обработка документов AIForged позволяет предприятиям увеличивать свои выходные данные с большей точностью, большей скоростью при более низкой стоимости.

Предпосылки

Вам потребуется следующее:

План Microsoft Power Apps или Power Automate

Вам нужна учетная запись Microsoft 365, план Power Automate и учетная запись AIForged или служба.

Учетная запись и служба AIForged

Чтобы использовать этот соединитель, вам потребуется учетная запись AIForged. Кроме того, необходимо настроить и обучить службу AIForged для получения точных результатов. Дополнительные инструкции регистрируются в AIForged и настраивают проект и службу AIForged, выполнив действия, определенные в разделе "Создание проекта".

Вот практический пример по извлечению информации из карт социального страхования Практический пример - Социальное обеспечение.

Также см. наш практический пример для извлечения информации из кредитных приложений Практический пример — кредитное приложение.

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

Учетная запись AIForged необходима для использования AIForged. Вы можете зарегистрировать, установив приложение AIForged на веб-сайте Microsoft Store или Microsoft Store.

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

Чтобы активировать учетную запись, необходимо получить сообщение электронной почты со ссылкой активации. Щелкнув ссылку активации, AIForged откроется с информацией о активации. После активации учетной записи вы можете войти с помощью учетных данных, а затем использовать свои учетные данные в соединителе.

Создание и обучение службы AIForged

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

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

Пример практики — карточки социального страхования.

Практический пример — банковские инструкции.

Практический пример — кредитное приложение.

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

Дополнительные сведения о начале работы см. в следующем руководстве по Power Automate . Начало работы

Authentication

Этот соединитель использует OAuth2 проверку подлинности (см. инструкции, описанные выше о том, как получить его). При создании нового соединителя (в Power Apps или Logic Apps) вам потребуется предоставить сведения о проверке подлинности из регистрации.

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

Невозможно включить MFA/2FA для учетных данных, используемых в соединителе.

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

Для любой поддержки или помощи создайте запрос в службу поддержки AIForged или отправьте сообщение электронной почты в support@aiforged.com

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

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

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

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

Действия

Извлечение параметров документа

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

Извлечение параметров документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	docid		integer	Идентификатор документа
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocumentExtraction

Отправка и извлечение сведений для проверки

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

Отправка и извлечение сведений для проверки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор службы	stpdId		integer	Идентификатор службы
Идентификатор проекта	projectId		integer	Идентификатор проекта
Файл	file		file	Файл
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о метаданных документа

Тело: AIForged.ViewModels.DocumentViewModel

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор службы	stpdId		integer	Идентификатор службы
Идентификатор проекта	projectId		integer	Идентификатор проекта
Данные файла	file		file	Данные файла
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о метаданных документа

Тело: AIForged.ViewModels.DocumentViewModel

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор службы	stpdId		integer	Идентификатор службы
Идентификатор проекта	projectId		integer	Идентификатор проекта
Идентификатор документа	docId		integer	Идентификатор документа
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Категории и классы для обучения и классификации

Тело: AIForged.ViewModels.ClassesViewModel

Поиск документов с помощью структурированных условий поиска. Результаты можно выстраить

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

Поиск документов с помощью структурированных условий поиска. Результаты можно выстраить

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Владелец документа	userId		string	Владелец документа
Идентификатор проекта	projectId		integer	Идентификатор проекта
Идентификатор службы	stpdId		integer	Идентификатор службы
Папка или использование	usage		integer	Папка или использование
Состояние	status		integer	Состояние
Фильтр имени класса	classname		string	Фильтр имени класса
Фильтр имени файла	filename		string	Фильтр имени файла
Фильтр типа файла	filetype		string	Фильтр типа файла
Диапазон дат начала для документов	start		date-time	Диапазон дат начала для документов
Диапазон дат окончания для документов	end		date-time	Диапазон дат окончания для документов
Главный или родительский элемент документа	masterid		integer	Главный или родительский элемент документа
Номер страницы	pageNo		integer	Номер страницы
Размер страницы	pageSize		integer	Размер страницы
Сортировка по полю	sortField		integer	Сортировка по полю
Направление сортировки на основе поля сортировки	sortDirection		integer	Направление сортировки на основе поля сортировки
Фильтрация комментариев	comment		string	Фильтрация комментариев
Фильтрация результатов	result		string	Фильтрация результатов
Фильтрация по идентификатору результата	resultId		string	Фильтрация по идентификатору результата
Фильтрация по индексу результатов	resultIndex		integer	Фильтрация по индексу результатов
Фильтрация по внешним идентификаторам	externalId		string	Фильтрация по внешним идентификаторам
Фильтрация для guid документации	docGuid		string	Фильтрация для guid документации
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocumentViewModel

Поиск проекта по имени

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

Поиск проекта по имени

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя
Имя проекта	projectName		string	Имя проекта
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Проекты — это контейнер для выставления счетов и служб

Тело: AIForged.ViewModels.ProjectViewModel

Получение аналитики проверки

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

Получение аналитики проверки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор проекта	projectId		integer	Идентификатор проекта
Идентификатор службы	stpdId		integer	Идентификатор службы
Только последние	latestOnly		boolean	Только последние
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.VerificationSummary

Получение большого двоичного объекта данных для идентификатора документа по типу изображения

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

Получение большого двоичного объекта данных для идентификатора документа по типу изображения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя, принадлежащий документу	userId		string	Идентификатор пользователя, принадлежащий документу
Идентификатор большого двоичного объекта	id		integer	Идентификатор большого двоичного объекта
Тип большого двоичного объекта	type		integer	Тип большого двоичного объекта
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: file

Получение большого двоичного объекта по ключу BLOB-объекта

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

Получение большого двоичного объекта по ключу BLOB-объекта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор большого двоичного объекта	id		integer	Идентификатор большого двоичного объекта
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: file

Получение всех категорий по проекту

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

Получение всех категорий по проекту

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор ptoject	projectId		integer	Идентификатор ptoject
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.ClassesViewModel

Получение документа и связанных с ним документов

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

Получение документа и связанных с ним документов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id		integer	Идентификатор документа
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о метаданных документа

Тело: AIForged.ViewModels.DocumentViewModel

Получение документа по идентификатору

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

Получение документа по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id		integer	Идентификатор документа
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о метаданных документа

Тело: AIForged.ViewModels.DocumentViewModel

Получение документов и изображений предварительной версии для службы

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

Получение документов и изображений предварительной версии для службы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Пользователь, принадлежащий службе	userId		string	Пользователь, принадлежащий службе
Идентификатор проекта	projectId		integer	Идентификатор проекта
Идентификатор службы	stpdId		integer	Идентификатор службы
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocumentViewModel

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	docId		integer	Идентификатор документа
Идентификатор службы	stpdId		integer	Идентификатор службы
Категория параметров	category		integer	Категория параметров
Группирование параметров	grouping		integer	Группирование параметров
Включение данных проверки	includeverification		boolean	Включение данных проверки
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocumentParameterViewModel

Получение иерархии параметров

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

Получение иерархии параметров

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	docId		integer	Идентификатор документа
Идентификатор службы	stpdId		integer	Идентификатор службы
Включение данных проверки	includeverification		boolean	Включение данных проверки
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocumentParameterViewModel

Получение иерархии полей для всех служб в проекте

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

Получение иерархии полей для всех служб в проекте

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя
Идентификатор проекта	projectId		integer	Идентификатор проекта
Идентификатор службы	stpdId		integer	Идентификатор службы
Идентификатор группы	groupId		integer	Идентификатор группы
Включение статистики счетчиков	includeCount		boolean	Включение статистики счетчиков
Только включить службы	onlyServices		boolean	Только включить службы
Включение параметров	includeSettings		boolean	Включение параметров
Включение дочерних элементов	includeChildren		boolean	Включение дочерних элементов
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.ParameterDefViewModel

Получение иерархии полей для службы

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

Получение иерархии полей для службы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор проекта	projectId		integer	Идентификатор проекта
Идентификатор службы	stpdId		integer	Идентификатор службы
Включение статистики счетчиков	includeCount		boolean	Включение статистики счетчиков
Включение параметров	includeSettings		boolean	Включение параметров
Включение дочерних определений	includeChildren		boolean	Включение дочерних определений
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Служба, параметры определений правил abd

Тело: AIForged.ViewModels.ParameterDefViewModel

Получение изображений документов

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

Получение изображений документов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id		integer	Идентификатор документа
Идентификатор службы	stpdId		integer	Идентификатор службы
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocumentDataViewModel

Получение изображений документов

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

Получение изображений документов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id		integer	Идентификатор документа
Тип изображения	type		integer	Тип изображения
Тип контента изображения	contentType		string	Тип контента изображения
Тестовый фильтр	text		string	Тестовый фильтр
Идентификатор связанного большого двоичного объекта	blobid		integer	Идентификатор связанного большого двоичного объекта
Индекс страницы	pageindex		integer	Индекс страницы
Количество возвращаемых изображений	imagesCount		integer	Количество возвращаемых изображений
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocumentDataViewModel

Получение изображения проверки

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

Получение изображения проверки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Пользователь для измельченных	userId		string	Пользователь для измельченных
Идентификатор документа	docId		integer	Идентификатор документа
Идентификатор параметра	parId		integer	Идентификатор параметра
Идентификатор проверки	verificationId		integer	Идентификатор проверки
Должен ли изображение быть встроенным	inline		boolean	Должен ли изображение быть встроенным
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: file

Получение ключа API для пользователя

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

Получение ключа API для пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: string

Получение определения по идентификатору

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

Получение определения по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор определения	id		integer	Идентификатор определения
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Служба, параметры определений правил abd

Тело: AIForged.ViewModels.ParameterDefViewModel

Получение определенного проекта

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

Получение определенного проекта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя
Идентификатор проекта	projectId		integer	Идентификатор проекта
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Проекты — это контейнер для выставления счетов и служб

Тело: AIForged.ViewModels.ProjectViewModel

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор проверки	verificationId		integer	Идентификатор проверки
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Значения полей, связанные ot, извлеченные из документов

Тело: AIForged.ViewModels.DocumentParameterViewModel

Получение пользователем и проектом

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

Получение пользователем и проектом

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя
Идентификатор проекта	projectId		integer	Идентификатор проекта
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.ClassesViewModel

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	docId		integer	Идентификатор документа
Идентификатор параметра	parameterId		integer	Идентификатор параметра
Идентификатор определения	pdId		integer	Идентификатор определения
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о системе и проверке пользователей для полей в документах

Тело: AIForged.ViewModels.VerificationViewModel

Получение проверки по идентификатору

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

Получение проверки по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор проверки	verificationId		integer	Идентификатор проверки
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о системе и проверке пользователей для полей в документах

Тело: AIForged.ViewModels.VerificationViewModel

Получение проверок в параметре

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

Получение проверок в параметре

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	docId		integer	Идентификатор документа
Идентификатор параметра	parameterId		integer	Идентификатор параметра
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.VerificationViewModel

Получение проектов и служб, связанных с пользователем

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

Получение проектов и служб, связанных с пользователем

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.ProjectViewModel

Получение родительской службы для параметра def by Id

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

Получение родительской службы для параметра def by Id

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор определения параметра	id		integer	Идентификатор определения параметра
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Служба, параметры определений правил abd

Тело: AIForged.ViewModels.ParameterDefViewModel

Получение сведений о классификации

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

Получение сведений о классификации

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор классификации	Id		integer	Идентификатор классификации
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Категории и классы для обучения и классификации

Тело: AIForged.ViewModels.ClassesViewModel

Получение сведений о системе и приложении

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

Получение сведений о системе и приложении

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: object

Получение сводки по проверке

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

Получение сводки по проверке

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор проекта	projectId		integer	Идентификатор проекта
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DocParamSummary

Получение сводки по проверке

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

Получение сводки по проверке

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор проекта	projectId		integer	Идентификатор проекта
Идентификатор службы	stpdId		integer	Идентификатор службы
Идентификатор определения	pdId		integer	Идентификатор определения
Только последние или журналы	latestOnly		boolean	Только последние или журналы
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.VerificationSummary

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.EnumDataViewModel

Получение служб, связанных с проектом

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

Получение служб, связанных с проектом

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя
Идентификатор проекта	projectId		integer	Идентификатор проекта
Фильтр типа службы	stlfilter		integer	Фильтр типа службы
Фильтрация по подсистеме	enginefilter		string	Фильтрация по подсистеме
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.ParameterDefViewModel

Получение службы по идентификатору

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

Получение службы по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор службы	stpdId		integer	Идентификатор службы
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Служба, параметры определений правил abd

Тело: AIForged.ViewModels.ParameterDefViewModel

Получение текущего пользователя, вошедшего в систему

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

Получение текущего пользователя, вошедшего в систему

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о пользователе

Тело: AIForged.ViewModels.UserViewModel

Получение текущих данных и времени службы

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

Получение текущих данных и времени службы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: date-time

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: array of AIForged.ViewModels.DataTypeViewModel

Удаление большого двоичного объекта документа

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

Удаление большого двоичного объекта документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор большого двоичного объекта	id		integer	Идентификатор большого двоичного объекта
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

response: file

Удаление документа по идентификатору

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

Удаление документа по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа для удаления	id		integer	Идентификатор документа для удаления
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Сведения о метаданных документа

Тело: AIForged.ViewModels.DocumentViewModel

Удаление параметра

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

Удаление параметра

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор параметра	paramid		integer	Идентификатор параметра
Заголовок версии API	X-Api-Version	True	string	Заголовок версии API

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

Значения полей, связанные ot, извлеченные из документов

Тело: AIForged.ViewModels.DocumentParameterViewModel

Определения

AIForged.ViewModels.UserViewModel

Сведения о пользователе

Имя	Путь	Тип
id	id	string
userName	userName	string
fullName	fullName	string
электронная почта	email	email
Название должности	jobTitle	string
номер телефона	phoneNumber	phone
configuration	configuration	string
isEnabled	isEnabled	boolean
isLockedOut	isLockedOut	boolean
friendlyName	friendlyName	string
создано кем	createdBy	string
обновленоBy	updatedBy	string
дата создания	createdDate	date-time
обновленная дата	updatedDate	date-time
roles	roles	array of string

AIForged.ViewModels.ClassesViewModel

Категории и классы для обучения и классификации

Имя	Путь	Тип	Описание
id	id	integer
userId	userId	string
projectId	projectId	integer
имя	name	string
описание	description	string
Комментарий	comment	string
dtc	dtc	date-time
dtm	dtm	date-time
type	type	AIForged.DAL.ClassType	Тип системной категории
родственный	related	integer

AIForged.DAL.ClassType

Тип системной категории

: integer

AIForged.ViewModels.DocumentViewModel

Сведения о метаданных документа

Имя	Путь	Тип	Описание
id	id	integer
userId	userId	string
projectId	projectId	integer
serviceId	serviceId	integer
статус	status	AIForged.DAL.DocumentStatus	Указание состояния документа в системе
использование	usage	AIForged.DAL.UsageType	Почему мы храним этот документ
classId	classId	integer
Тип контента	contentType	string
filename	filename	string
fileType	fileType	string
dtc	dtc	date-time
dtm	dtm	date-time
documentId	documentId	guid
externalId (внешний идентификатор)	externalId	string
masterId	masterId	integer
результат	result	string
resultId	resultId	string
resultIndex	resultIndex	integer
Комментарий	comment	string
availability	availability	AIForged.DAL.Availability	Доступность записи
resultParameters	resultParameters	array of AIForged.ViewModels.DocumentParameterViewModel
данные	data	array of AIForged.ViewModels.DocumentDataViewModel
Документы	documents	array of AIForged.ViewModels.DocumentViewModel
originId	originId	integer
canVerify	canVerify	boolean
canClassify	canClassify	boolean
canTrain	canTrain	boolean
обученный	trained	boolean
linkedDocsCount	linkedDocsCount	integer
trainingFieldCount	trainingFieldCount	integer
ОбученныеParametersCount	trainedParametersCount	integer

AIForged.DAL.DocumentStatus

Указание состояния документа в системе

: integer

AIForged.DAL.UsageType

Почему мы храним этот документ

: integer

AIForged.DAL.Availability

Доступность записи

: integer

AIForged.ViewModels.DocumentParameterViewModel

Значения полей, связанные ot, извлеченные из документов

Имя	Путь	Тип	Описание
id	id	integer
documentId	documentId	integer
paramDefId	paramDefId	integer
parentId	parentId	integer
sourceId	sourceId	integer
value	value	string
данные	data	byte
index	index	integer
colIndex	colIndex	integer
КолСпан	colSpan	integer
rowIndex	rowIndex	integer
Функция rowSpan	rowSpan	integer
availability	availability	AIForged.DAL.Availability	Доступность записи
paramDef	paramDef		Служба, параметры определений правил abd
children	children	array of AIForged.ViewModels.DocumentParameterViewModel
Проверки	verifications	array of AIForged.ViewModels.VerificationViewModel

AIForged.ViewModels.ParameterDefViewModel

Служба, параметры определений правил abd

Имя	Путь	Тип	Описание
id	id	integer
projectId	projectId	integer
serviceTypeId	serviceTypeId	integer
serviceId	serviceId	integer
classId	classId	integer
parentId	parentId	integer
имя	name	string
label	label	string
tags	tags	string
описание	description	string
dtc	dtc	date-time
dtm	dtm	date-time
статус	status	AIForged.DAL.ParameterDefinitionStatus	Состояние определения
категория	category	AIForged.DAL.ParameterDefinitionCategory	Категория определения
группировка	grouping	AIForged.DAL.GroupingType	Тип группировки полей
valueType	valueType	AIForged.DAL.ValueType	Тип значений, используемых для правил и параметров
valueTypeName	valueTypeName	string
defaultValue	defaultValue	string
required	required	AIForged.DAL.RequiredOption	Укажите, требуется ли параметр
index	index	integer
info	info	string
справочник	reference	string
рейтинг	rating	float
availability	availability	AIForged.DAL.Availability	Доступность записи
children	children	array of AIForged.ViewModels.ParameterDefViewModel
settings	settings	array of AIForged.DAL.Models.ParameterDefSettingViewModel
totalCharge	totalCharge	double
количество пользователей	userCount	integer
parameterCount	parameterCount	integer
documentCount	documentCount	integer
ратификация	validation	string

AIForged.DAL.ParameterDefinitionStatus

Состояние определения

: integer

AIForged.DAL.ParameterDefinitionCategory

Категория определения

: integer

AIForged.DAL.GroupingType

Тип группировки полей

: integer

AIForged.DAL.ValueType

Тип значений, используемых для правил и параметров

: integer

AIForged.DAL.RequiredOption

Укажите, требуется ли параметр

: integer

AIForged.DAL.Models.ParameterDefSettingViewModel

Подробные параметры правил и параметров

Имя	Путь	Тип	Описание
id	id	integer
parameterDefId	parameterDefId	integer
type	type	AIForged.DAL.SettingType	Тип параметра, связанного с параметром
статус	status	AIForged.DAL.SettingStatus	Состояние параметра, связанного с параметром
dtc	dtc	date-time
dtm	dtm	date-time
Комментарий	comment	string
info	info	string
данные	data	string
минимальное значение	minValue	string
максимальное значение	maxValue	string
уверенность	confidence	float
minConfidence	minConfidence	float
maxConfidence	maxConfidence	float
isCaseSensative	isCaseSensative	boolean
инвертировать	invert	boolean
oneLine	oneLine	boolean
oneWord	oneWord	boolean
isHandwriting	isHandwriting	boolean
ориентация	orientation	AIForged.DAL.Orientation	Ориентация текста поля
маркировка	marking	AIForged.DAL.MarkingType	Маркировка типа текста
Клетки	cells	integer
clearBefore	clearBefore	AIForged.DAL.OptionStatusFlags	Флаг состояния параметров
clearAfter	clearAfter	AIForged.DAL.OptionStatusFlags	Флаг состояния параметров
cleanupValuesBefore	cleanupValuesBefore	boolean
cleanupValuesAfter	cleanupValuesAfter	boolean
validateValuesBefore	validateValuesBefore	boolean
validateValuesAfter	validateValuesAfter	boolean
abortOnValidationError	abortOnValidationError	boolean
isReplacementCaseSensative	isReplacementCaseSensative	boolean
компиляцияResults	compileResults	string
maxRetry	maxRetry	integer
timeout	timeout	string
userId	userId	string

AIForged.DAL.SettingType

Тип параметра, связанного с параметром

: integer

AIForged.DAL.SettingStatus

Состояние параметра, связанного с параметром

: integer

AIForged.DAL.Orientation

Ориентация текста поля

: integer

AIForged.DAL.MarkingType

Маркировка типа текста

: integer

AIForged.DAL.OptionStatusFlags

Флаг состояния параметров

: integer

AIForged.ViewModels.AuthenticationViewModel

Сведения о системе и проверке пользователей для полей в документах

Имя	Путь	Тип	Описание
id	id	integer
parameterId	parameterId	integer
userId	userId	string
value	value	string
dt	dt	date-time
уверенность	confidence	float
символыConfidence	symbolsConfidence	string
type	type	AIForged.DAL.VerificationType	Тип проверки
статус	status	AIForged.DAL.VerificationStatus	Флаги состояния проверки
результат	result	string
поле	box	string
info	info	string
данные	data	byte
userName	userName	string
serviceId	serviceId	integer
serviceDocId	serviceDocId	integer
provider	provider	string
settingId	settingId	integer
workItem	workItem	integer
transactionId	transactionId	integer
обвинение	charge	double

AIForged.DAL.AuthenticationType

Тип проверки

: integer

AIForged.DAL.AuthenticationStatus

Флаги состояния проверки

: integer

AIForged.ViewModels.DocumentDataViewModel

Документ данных BLOB-объектов

Имя	Путь	Тип	Описание
id	id	integer
documentId	documentId	integer
BLOBId	blobId	integer
type	type	AIForged.DAL.DocumentDataType	Указание типа данных, связанных с документом
данные	data	byte
предварительный просмотр	preview	byte
текст	text	string
info	info	string
Тип контента	contentType	string
resultId	resultId	string
index	index	integer
Ширина	width	double
height	height	double
разрешение	resolution	double
availability	availability	AIForged.DAL.Availability	Доступность записи

AIForged.DAL.DocumentDataType

Указание типа данных, связанных с документом

: integer

AIForged.ViewModels.DocParamSummary

Сводка по документам для статистики с сведениями о параметрах

Имя	Путь	Тип	Описание
projectId	projectId	integer
тип услуги	serviceType	integer
serviceId	serviceId	integer
использование	usage	AIForged.DAL.UsageType	Почему мы храним этот документ
статус	status	AIForged.DAL.DocumentStatus	Указание состояния документа в системе
имя	name	string
classId	classId	integer
className	className	string
serviceName	serviceName	string
fileType	fileType	string
dt	dt	date-time
count	count	integer
labelledCount	labelledCount	integer
pdId	pdId	integer
paramDefName	paramDefName	string
категория	category	AIForged.DAL.ParameterDefinitionCategory	Категория определения
группировка	grouping	AIForged.DAL.GroupingType	Тип группировки полей
valueType	valueType	AIForged.DAL.ValueType	Тип значений, используемых для правил и параметров
value	value	string
index	index	integer

AIForged.ViewModels.DocumentExtraction

Транспонированное извлечение структурированных результатов документа

Имя	Путь	Тип	Описание
id	id	integer
parentId	parentId	integer
имя	name	string
label	label	string
категория	category	AIForged.DAL.ParameterDefinitionCategory	Категория определения
группировка	grouping	AIForged.DAL.GroupingType	Тип группировки полей
valueType	valueType	AIForged.DAL.ValueType	Тип значений, используемых для правил и параметров
index	index	integer
paramId	paramId	integer
parentParamId	parentParamId	integer
paramIndex	paramIndex	integer
paramValue	paramValue	string
authenticationId	verificationId	integer
userId	userId	string
userName	userName	string
value	value	string
dt	dt	date-time
уверенность	confidence	float
type	type	AIForged.DAL.VerificationType	Тип проверки
статус	status	AIForged.DAL.VerificationStatus	Флаги состояния проверки
обвинение	charge	double
provider	provider	string
результат	result	string

AIForged.ViewModels.ProjectViewModel

Проекты — это контейнер для выставления счетов и служб

Имя	Путь	Тип	Описание
id	id	integer
userId	userId	string
статус	status	AIForged.DAL.ProjectStatus	Используется для указания состояния проекта
имя	name	string
описание	description	string
Комментарий	comment	string
dtc	dtc	date-time
dtm	dtm	date-time
равновесие	balance		Учетная информация для проектов и служб
totalDocsCount	totalDocsCount	integer
services	services	array of AIForged.ViewModels.ParameterDefViewModel

AIForged.DAL.ProjectStatus

Используется для указания состояния проекта

: integer

AIForged.ViewModels.DataTypeViewModel

Типы данных, используемые для правил и внутренней обработки

Имя	Путь	Тип	Описание
id	id	AIForged.DAL.ValueType	Тип значений, используемых для правил и параметров
имя	name	string
описание	description	string
категория	category	AIForged.DAL.DataTypeCategory	Категория типов данных
valueTypeName	valueTypeName	string
defaultValue	defaultValue	string
данные	data	string

AIForged.DAL.DataTypeCategory

Категория типов данных

: integer

AIForged.ViewModels.EnumDataViewModel

Список системных перечислений и базовых сведений о пользовательском интерфейсе

Имя	Путь	Тип	Описание
id	id	integer
type	type	AIForged.DAL.EnumType	Перечисление всех перечислений в системе
typeName	typeName	string
имя	name	string
value	value	integer
описание	description	string
info	info	string
icon	icon	string
color	color	string

AIForged.DAL.EnumType

Перечисление всех перечислений в системе

: integer

AIForged.ViewModels.AuthenticationSummary

Сведения о системе и проверке пользователей для полей в документах

Имя	Путь	Тип	Описание
id	id	integer
parameterId	parameterId	integer
userId	userId	string
value	value	string
dt	dt	date-time
уверенность	confidence	float
символыConfidence	symbolsConfidence	string
type	type	AIForged.DAL.VerificationType	Тип проверки
статус	status	AIForged.DAL.VerificationStatus	Флаги состояния проверки
результат	result	string
поле	box	string
info	info	string
данные	data	byte
userName	userName	string
serviceId	serviceId	integer
serviceDocId	serviceDocId	integer
provider	provider	string
settingId	settingId	integer
workItem	workItem	integer
transactionId	transactionId	integer
обвинение	charge	double
paramDefId	paramDefId	integer
paramDefName	paramDefName	string
projectId	projectId	integer
имя проекта	projectName	string
docId	docId	integer
docFileName	docFileName	string
docContentType	docContentType	string
docUsage	docUsage	AIForged.DAL.UsageType	Почему мы храним этот документ
docStatus	docStatus	AIForged.DAL.DocumentStatus	Указание состояния документа в системе
classId	classId	integer
className	className	string
год	year	integer
month	month	integer
day	day	integer
день недели	dayOfWeek	System.DayOfWeek	Календарный день недели
count	count	integer
средний	average	float
min	min	float
max	max	float

System.DayOfWeek

Календарный день недели

: integer

file

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

струна

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

объект

Это тип object.

date-time

: date-time