Alquimia

A Alkymi transforma fluxos de trabalho corporativos colocando o aprendizado de máquina e a tecnologia de automação nas mãos dos usuários corporativos, transformando dores de cabeça com dados operacionais em uma fonte de eficiência. Os principais produtos da Alkymi — Data Inbox and Patterns — permitem que as empresas extraiam, analisem e tomem medidas sobre dados comerciais críticos em e-mails e documentos. O conector Alkymi permite que você acesse facilmente os dados extraídos de documentos não estruturados processados pelo aplicativo Alkymi.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes:      - Regiões do Azure Government      - Regiões do Azure China      - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte Alkymi
URL	https://www.alkymi.io/contact
Email	tori@alkymi.io

Metadados do conector
Editora	Alquimia
Sítio Web	https://alkymi.io
Política de privacidade	https://www.alkymi.io/privacy-policy
Categorias	Conteúdo e Ficheiros

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API	securestring	A chave de API para esta api	Verdade
Nome do anfitrião	cadeia (de caracteres)	O nome do anfitrião do seu inquilino	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Carregar arquivo de documento	Carrega um arquivo em um locatário da Caixa de Entrada de Dados para processamento.
Listar todas as execuções	Lista todas as execuções disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g
Listar todos os conjuntos de dados	Lista todos os conjuntos de dados disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR
Listar todos os documentos	Lista todos os documentos disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH
Listar todos os padrões	Liste todos os padrões disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb
Listar todos os registros	Lista todos os registros disponíveis no locatário. Por exemplo, você pode retornar todos os registros para um padrão específico se o locatário estiver configurado com vários padrões. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs
Obter arquivo de documento (formato original)	Baixa uma cópia do arquivo de documento postado na Caixa de Entrada de Dados em seu formato original.
Obter arquivo de documento (formato PDF)	Transfere uma cópia do ficheiro de documento publicado na Caixa de Entrada de Dados num formato PDF convertido.
Obter informações de execução	Recupere uma instância de execução específica. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX
Obter informações de padrão	Recupere uma instância de padrão específica. O registro de padrão retornado pode exigir análise adicional antes de usar downstream no fluxo de trabalho.
Obter informações de registro	Recupere uma instância de registro específica. O objeto de registro retornado pode exigir análise adicional antes de usar downstream no fluxo de trabalho. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM
Obter informações do conjunto de dados	Recupere uma instância específica do conjunto de dados. O registro de conjunto de dados retornado pode exigir análise adicional antes de usar downstream no fluxo de trabalho. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr
Obter informações do documento	Recupere uma instância de documento específica. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh

Carregar arquivo de documento

ID da Operação:

documents_create

Carrega um arquivo em um locatário da Caixa de Entrada de Dados para processamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Booleano removido	removed		boolean	removido
UUID do conjunto de dados	dataset		string	UUID do conjunto de dados
Assunto	subject		string	Assunto
Remetente	sender		string	remetente
Folder	folder		string	pasta
Nome do arquivo	file	True	file	nome de ficheiro
Padrões direcionados	targets		array	Nomes de padrões direcionados

Listar todas as execuções

ID da Operação:

executions_list

Lista todas as execuções disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g

Parâmetros

Name	Chave	Necessário	Tipo	Description
Estado do documento	document_status		array	Estado do documento

Devoluções

lista de execução

PaginatedExecutionList

PaginatedExecutionList

Listar todos os conjuntos de dados

ID da Operação:

datasets_list

Lista todos os conjuntos de dados disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR

Devoluções

Lista de conjuntos de dados

PaginatedDatasetList

PaginatedDatasetList

Listar todos os documentos

ID da Operação:

documents_list

Lista todos os documentos disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH

Devoluções

Name	Caminho	Tipo	Description
count	count	integer	count
next	next	string	next
anterior	previous	string	anterior
results	results	array of Document

Listar todos os padrões

ID da Operação:

pipelines_list

Liste todos os padrões disponíveis no locatário. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb

Devoluções

Lista de configuração de pipeline

PaginatedPipelineConfigurationList

PaginatedPipelineConfigurationList

Listar todos os registros

ID da Operação:

records_list

Lista todos os registros disponíveis no locatário. Por exemplo, você pode retornar todos os registros para um padrão específico se o locatário estiver configurado com vários padrões. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs

Parâmetros

Name	Chave	Necessário	Tipo	Description
UUID do conjunto de dados	dataset		uuid	UUID do conjunto de dados
Status de processamento	document_status		array	Estado de processamento
Padrão	pipeline		string	nome do padrão
Status removido	removed		boolean	status removido
Status revisado	reviewed		boolean	estado revisto
Schema	schema		string	esquema

Devoluções

Lista de registos

PaginatedRecordList

PaginatedRecordList

Obter arquivo de documento (formato original)

ID da Operação:

documents_download_original_retrieve

Baixa uma cópia do arquivo de documento postado na Caixa de Entrada de Dados em seu formato original.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Documento UUID	uuid	True	uuid	uuid documento

Devoluções

response

binary

Obter arquivo de documento (formato PDF)

ID da Operação:

documents_download_pdf_retrieve

Transfere uma cópia do ficheiro de documento publicado na Caixa de Entrada de Dados num formato PDF convertido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Documento UUID	uuid	True	uuid	uuid documento

Devoluções

response

binary

Obter informações de execução

ID da Operação:

executions_retrieve

Recupere uma instância de execução específica. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX

Parâmetros

Name	Chave	Necessário	Tipo	Description
Execução UUID	uuid	True	uuid	execução uuid

Devoluções

execução

Execution

Execution

Obter informações de padrão

ID da Operação:

pipelines_retrieve

Recupere uma instância de padrão específica. O registro de padrão retornado pode exigir análise adicional antes de usar downstream no fluxo de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do padrão	name	True	string	nome do padrão

Devoluções

padrão

Configuração do Pipeline

PipelineConfiguration

Obter informações de registro

ID da Operação:

records_retrieve

Recupere uma instância de registro específica. O objeto de registro retornado pode exigir análise adicional antes de usar downstream no fluxo de trabalho. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM

Parâmetros

Name	Chave	Necessário	Tipo	Description
Gravar UUID	uuid	True	uuid	Gravar UUID

Devoluções

registo

Gravar / Registo

Record

Obter informações do conjunto de dados

ID da Operação:

datasets_retrieve

Recupere uma instância específica do conjunto de dados. O registro de conjunto de dados retornado pode exigir análise adicional antes de usar downstream no fluxo de trabalho. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr

Parâmetros

Name	Chave	Necessário	Tipo	Description
UUID do conjunto de dados	uuid	True	uuid	UUID do conjunto de dados

Devoluções

Lista de conjuntos de dados

PaginatedDatasetList

PaginatedDatasetList

Obter informações do documento

ID da Operação:

documents_retrieve

Recupere uma instância de documento específica. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh

Parâmetros

Name	Chave	Necessário	Tipo	Description
Documento UUID	uuid	True	uuid	uuid documento

Devoluções

documento

Documento

Document

Acionadores

Quando um evento Alkymi é acionado

Este gatilho é executado quando qualquer um dos eventos Alkymi selecionados ocorre.

Quando um evento Alkymi é acionado

ID da Operação:

event_listener

Este gatilho é executado quando qualquer um dos eventos Alkymi selecionados ocorre.

Parâmetros

Name	Chave	Necessário	Tipo	Description
display_name	display_name		string	nome a apresentar
Events	events		array of string	Eventos Webhook

Devoluções

evento webhook

WebhookEvento

WebHookEvent

Definições

Dataset

conjunto de dados

Name	Caminho	Tipo	Description
Identificador Único Universal (UUID)	uuid	uuid
nome	name	string
pipeline	pipeline	string
Documentação	documents	string
registos	records	string

Documento

documento

Name	Caminho	Tipo	Description
Identificador Único Universal (UUID)	uuid	string	Identificador Único Universal (UUID)
criado	created	string	criado
modified	modified	string	modified
estado	status	string	estado
arquivado	archived	boolean	arquivado
removido	removed	boolean	removido
nome_do_ficheiro	file_name	string	nome de ficheiro
page_count	page_count	integer	contagem de páginas
pages	pages	array of object	pages
número	pages.number	integer	número
Largura	pages.width	integer	Largura
altura	pages.height	integer	altura
conjunto de dados	dataset	string	conjunto de dados
registos	records	array of	registos
pipeline_records	pipeline_records	object	Registros de pipeline
_s3_key	_s3_key	string	Tecla S3
_replaced_by	_replaced_by	string	substituída por
Assunto	subject	string	Assunto
remetente	sender	string	remetente
pasta	folder	string	pasta
watermark_removed	watermark_removed	boolean	marca d'água removida

Execution

execução

Name	Caminho	Tipo	Description
Identificador Único Universal (UUID)	uuid	uuid
criado	created	date-time
avaliou	reviewed	boolean
arquivado	archived	boolean
estado	status	string
registos	records	array of string
pipeline_records	pipeline_records	object
nome_do_ficheiro	file_name	string
Documentação	documents	array of string

PaginatedDatasetList

Lista de conjuntos de dados

Name	Caminho	Tipo	Description
count	count	integer
next	next	string
anterior	previous	string
results	results	array of Dataset

PaginatedExecutionList

lista de execução

Name	Caminho	Tipo	Description
count	count	integer
next	next	string
anterior	previous	string
results	results	array of Execution

PaginatedPipelineConfigurationList

Lista de configuração de pipeline

Name	Caminho	Tipo	Description
count	count	integer
next	next	string
anterior	previous	string
results	results	array of PipelineConfiguration

PaginatedRecordList

Lista de registos

Name	Caminho	Tipo	Description
count	count	integer
next	next	string
anterior	previous	string
results	results	array of Record

Configuração do Pipeline

padrão

Name	Caminho	Tipo	Description
nome	name	string
registos	records	string
schemas	schemas	array of Schema

Gravar / Registo

registo

Name	Caminho	Tipo	Description
Identificador Único Universal (UUID)	uuid	uuid
criado	created	date-time
modified	modified	date-time
document_uuid	document_uuid	string
documento	document	string
conjunto de dados	dataset	string
pipeline	pipeline	string
schema_name	schema_name	string
estado	status	string
dados	data	object

Schema

esquema

Name	Caminho	Tipo	Description
nome	name	string
primário	primary	boolean
campos	fields	array of SchemaField

SchemaField

Campo de esquema

Name	Caminho	Tipo	Description
nome	name	string
field_type	field_type	string
sub_schema	sub_schema	string

WebHookEvento

evento webhook

Name	Caminho	Tipo	Description
Identificador Único Universal (UUID)	uuid	string	Identificador Único Universal (UUID)
estado	status	string	estado
criado	created	string	criado
registos	records	array of string	registos
arquivado	archived	boolean	arquivado
avaliou	reviewed	boolean	avaliou
Documentação	documents	array of string	Documentação
nome_do_ficheiro	file_name	string	nome de ficheiro
pipeline_records	pipeline_records	object	Registros de pipeline
trigger_event_list	trigger_event_list	array of string	Lista de eventos de gatilho

binário

Este é o tipo de dados básico 'binário'.