Алкими

Alkymi преобразует рабочие процессы предприятия, размещая технологии машинного обучения и автоматизации в руки бизнес-пользователей, превращая операционные головные боли данных в источник эффективности. Основные продукты Alkymi — "Входящие данные" и "Шаблоны" позволяют предприятиям извлекать, анализировать и принимать меры по критически важным бизнес-данным в сообщениях электронной почты и документах. Соединитель Alkymi позволяет легко получить доступ к данным, извлеченным из неструктурированных документов, обработанных приложением Alkymi.

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

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

Контакт
Имя	Поддержка Alkymi
URL	https://www.alkymi.io/contact
Адрес электронной почты	tori@alkymi.io

Метаданные соединителя
Publisher	Алкими
Веб-сайт	https://alkymi.io
Политика конфиденциальности	https://www.alkymi.io/privacy-policy
Категории	Содержимое и файлы

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

Соединитель поддерживает следующие типы проверки подлинности:

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

По умолчанию

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

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

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

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API	True
Имя узла	струна	Имя узла клиента	True

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

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

Действия

Вывод списка всех выполнений	Перечисляет все доступные в клиенте выполнения. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g
Вывод списка всех документов	Выводит список всех документов, доступных в клиенте. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH
Вывод списка всех записей	Выводит список всех записей, доступных в клиенте. Например, можно вернуть все записи для определенного шаблона, если клиент настроен с несколькими шаблонами. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs
Вывод списка всех наборов данных	Выводит список всех наборов данных, доступных в клиенте. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR
Вывод списка всех шаблонов	Список всех шаблонов, доступных в клиенте. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb
Отправка файла документа	Отправляет файл в клиент Data Inbox для обработки.
Получение сведений о выполнении	Получение определенного экземпляра выполнения. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX
Получение сведений о документе	Получение определенного экземпляра документа. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh
Получение сведений о записи	Получение определенного экземпляра записи. Возвращаемый объект записи может потребовать дополнительного синтаксического анализа перед использованием нижестоящего потока в рабочем процессе. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM
Получение сведений о наборе данных	Получение определенного экземпляра набора данных. Возвращаемая запись набора данных может потребовать дополнительного анализа перед использованием нижестоящего потока в рабочем процессе. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr
Получение сведений о шаблонах	Получение определенного экземпляра шаблона. Возвращаемая запись шаблона может потребовать дополнительного анализа перед использованием нижестоящего потока в рабочем процессе.
Получение файла документа (исходный формат)	Скачивает копию файла документа, размещенного в папку "Входящие данных" в исходном формате.
Получение файла документа (формат PDF)	Скачивает копию файла документа, размещенного в папку "Входящие данные" в преобразованном формате PDF.

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

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

executions_list

Перечисляет все доступные в клиенте выполнения. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Состояние документа	document_status		array	Состояние документа

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

Список выполнения

PaginatedExecutionList

PaginatedExecutionList

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

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

documents_list

Выводит список всех документов, доступных в клиенте. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH

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

Имя	Путь	Тип	Описание
count	count	integer	count
next	next	string	next
предыдущий	previous	string	предыдущий
results	results	array of Document

Вывод списка всех записей

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

records_list

Выводит список всех записей, доступных в клиенте. Например, можно вернуть все записи для определенного шаблона, если клиент настроен с несколькими шаблонами. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор UUID набора данных	dataset		uuid	uuid набора данных
Состояние обработки	document_status		array	Состояние обработки
Рисунок	pipeline		string	Имя шаблона
Удалено состояние	removed		boolean	Удалено состояние
Просмотр состояния	reviewed		boolean	Просмотр состояния
Schema	schema		string	schema

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

список записей

PaginatedRecordList

PaginatedRecordList

Вывод списка всех наборов данных

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

datasets_list

Выводит список всех наборов данных, доступных в клиенте. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR

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

Список наборов данных

PaginatedDatasetList

PaginatedDatasetList

Вывод списка всех шаблонов

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

pipelines_list

Список всех шаблонов, доступных в клиенте. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb

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

Список конфигураций конвейера

Список страниц с разбивкой на страницыPipelineConfigurationList

PaginatedPipelineConfigurationList

Отправка файла документа

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

documents_create

Отправляет файл в клиент Data Inbox для обработки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Удален логическое значение	removed		boolean	Удалено
Идентификатор UUID набора данных	dataset		string	uuid набора данных
Тема	subject		string	субъект
Отправитель	sender		string	отправитель;
Folder	folder		string	folder
Имя файла	file	True	file	имя файла
Целевые шаблоны	targets		array	имена целевых шаблонов

Получение сведений о выполнении

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

executions_retrieve

Получение определенного экземпляра выполнения. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Выполнение UUID	uuid	True	uuid	выполнение uuid

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

исполнение

Execution

Execution

Получение сведений о документе

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

documents_retrieve

Получение определенного экземпляра документа. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh

Параметры

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

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

документ

Документ

Document

Получение сведений о записи

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

records_retrieve

Получение определенного экземпляра записи. Возвращаемый объект записи может потребовать дополнительного синтаксического анализа перед использованием нижестоящего потока в рабочем процессе. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Запись UUID	uuid	True	uuid	record uuid

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

запись

Запись

Record

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

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

datasets_retrieve

Получение определенного экземпляра набора данных. Возвращаемая запись набора данных может потребовать дополнительного анализа перед использованием нижестоящего потока в рабочем процессе. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr

Параметры

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

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

Список наборов данных

PaginatedDatasetList

PaginatedDatasetList

Получение сведений о шаблонах

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

pipelines_retrieve

Получение определенного экземпляра шаблона. Возвращаемая запись шаблона может потребовать дополнительного анализа перед использованием нижестоящего потока в рабочем процессе.

Параметры

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

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

pattern

PipelineConfiguration

PipelineConfiguration

Получение файла документа (исходный формат)

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

documents_download_original_retrieve

Скачивает копию файла документа, размещенного в папку "Входящие данных" в исходном формате.

Параметры

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

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

response

binary

Получение файла документа (формат PDF)

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

documents_download_pdf_retrieve

Скачивает копию файла документа, размещенного в папку "Входящие данные" в преобразованном формате PDF.

Параметры

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

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

response

binary

Триггеры

При активации события Alkymi

Этот триггер выполняется при возникновении любого из выбранных событий Alkymi.

При активации события Alkymi

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

event_listener

Этот триггер выполняется при возникновении любого из выбранных событий Alkymi.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
display_name	display_name		string	отображаемое имя
Events	events		array of string	События веб-перехватчика

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

Событие веб-перехватчика

WebhookEvent

WebHookEvent

Определения

Dataset

dataset

Имя	Путь	Тип	Описание
UUID (Универсальный уникальный идентификатор)	uuid	uuid
имя	name	string
pipeline	pipeline	string
Документы	documents	string
Записи	records	string

Документ

документ

Имя	Путь	Тип	Описание
UUID (Универсальный уникальный идентификатор)	uuid	string	UUID (Универсальный уникальный идентификатор)
создано	created	string	создано
изменено	modified	string	изменено
статус	status	string	статус
Архив	archived	boolean	Архив
Удалено	removed	boolean	Удалено
file_name	file_name	string	имя файла
page_count	page_count	integer	количество страниц
pages	pages	array of object	pages
число/номер	pages.number	integer	число/номер
Ширина	pages.width	integer	Ширина
height	pages.height	integer	height
dataset	dataset	string	dataset
Записи	records	array of	Записи
pipeline_records	pipeline_records	object	Записи конвейера
_s3_key	_s3_key	string	ключ s3
_replaced_by	_replaced_by	string	Заменены
субъект	subject	string	субъект
отправитель;	sender	string	отправитель;
folder	folder	string	folder
watermark_removed	watermark_removed	boolean	удаление водяного знака

Execution

исполнение

Имя	Путь	Тип	Описание
UUID (Универсальный уникальный идентификатор)	uuid	uuid
создано	created	date-time
reviewed	reviewed	boolean
Архив	archived	boolean
статус	status	string
Записи	records	array of string
pipeline_records	pipeline_records	object
file_name	file_name	string
Документы	documents	array of string

PaginatedDatasetList

Список наборов данных

Имя	Путь	Тип	Описание
count	count	integer
next	next	string
предыдущий	previous	string
results	results	array of Dataset

PaginatedExecutionList

Список выполнения

Имя	Путь	Тип	Описание
count	count	integer
next	next	string
предыдущий	previous	string
results	results	array of Execution

Список страниц с разбивкой на страницыPipelineConfigurationList

Список конфигураций конвейера

Имя	Путь	Тип	Описание
count	count	integer
next	next	string
предыдущий	previous	string
results	results	array of PipelineConfiguration

PaginatedRecordList

список записей

Имя	Путь	Тип	Описание
count	count	integer
next	next	string
предыдущий	previous	string
results	results	array of Record

PipelineConfiguration

pattern

Имя	Путь	Тип	Описание
имя	name	string
Записи	records	string
schemas	schemas	array of Schema

Запись

запись

Имя	Путь	Тип	Описание
UUID (Универсальный уникальный идентификатор)	uuid	uuid
создано	created	date-time
изменено	modified	date-time
document_uuid	document_uuid	string
документ	document	string
dataset	dataset	string
pipeline	pipeline	string
schema_name	schema_name	string
статус	status	string
данные	data	object

Schema

schema

Имя	Путь	Тип	Описание
имя	name	string
основной	primary	boolean
столбцов	fields	array of SchemaField

SchemaField

Поле схемы

Имя	Путь	Тип	Описание
имя	name	string
field_type	field_type	string
sub_schema	sub_schema	string

WebHookEvent

Событие веб-перехватчика

Имя	Путь	Тип	Описание
UUID (Универсальный уникальный идентификатор)	uuid	string	UUID (Универсальный уникальный идентификатор)
статус	status	string	статус
создано	created	string	создано
Записи	records	array of string	Записи
Архив	archived	boolean	Архив
reviewed	reviewed	boolean	reviewed
Документы	documents	array of string	Документы
file_name	file_name	string	имя файла
pipeline_records	pipeline_records	object	Записи конвейера
trigger_event_list	trigger_event_list	array of string	Список событий триггера

бинарный

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