Delen via

Alkymi

Alkymi transformeert bedrijfswerkstromen door machine learning- en automatiseringstechnologie in handen van zakelijke gebruikers te plaatsen en operationele gegevenshoofdpijn om te zetten in een bron van efficiëntie. De kernproducten van Alkymi ( Postvak IN en patronen voor gegevens) bieden bedrijven de mogelijkheid om kritieke bedrijfsgegevens in e-mailberichten en documenten te extraheren, analyseren en er actie op te ondernemen. Met de Alkymi-connector kunt u eenvoudig toegang krijgen tot de gegevens die zijn geëxtraheerd uit ongestructureerde documenten die door de Alkymi-app worden verwerkt.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Alkymi-ondersteuning
URL https://www.alkymi.io/contact
E-mailen tori@alkymi.io
Connectormetagegevens
Uitgever Alkymi
Webpagina https://alkymi.io
Privacybeleid https://www.alkymi.io/privacy-policy
Categorieën Inhoud en bestanden

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:
standaard Parameters voor het maken van verbinding. Alle regio's Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam Typologie Description Verplicht
API-sleutel beveiligde string De API-sleutel voor deze API Klopt
Hostnaam touw De hostnaam van uw tenant Klopt

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Alle documenten weergeven

Een lijst met alle documenten die beschikbaar zijn op de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH
Alle gegevenssets weergeven

Geeft een lijst weer van alle gegevenssets die beschikbaar zijn voor de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR
Alle patronen weergeven

Geef een lijst weer van alle patronen die beschikbaar zijn voor de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb
Alle records weergeven

Een lijst met alle records die beschikbaar zijn voor de tenant. U kunt bijvoorbeeld alle records voor een specifiek patroon retourneren als de tenant is geconfigureerd met meerdere patronen. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs
Alle uitvoeringen weergeven

Geeft een lijst weer van alle uitvoeringen die beschikbaar zijn voor de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g
Documentbestand ophalen (oorspronkelijke indeling)

Hiermee downloadt u een kopie van het documentbestand dat in het Postvak IN van Data is geplaatst in de oorspronkelijke indeling.
Documentbestand ophalen (PDF-indeling)

Hiermee downloadt u een kopie van het documentbestand dat in het Postvak IN van Data is geplaatst in een geconverteerde PDF-indeling.
Documentbestand uploaden

Uploadt een bestand naar een Data Inbox-tenant voor verwerking.
Documentgegevens ophalen

Een specifiek documentexemplaren ophalen. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh
Gegevenssetgegevens ophalen

Een specifiek gegevenssetexemplaren ophalen. De geretourneerde gegevenssetrecord vereist mogelijk extra parsering voordat u downstream in de werkstroom gebruikt. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr
Patroongegevens ophalen

Een specifiek patroonexemplaren ophalen. De geretourneerde patroonrecord kan extra parseren vereisen voordat u downstream in de werkstroom gebruikt.
Recordgegevens ophalen

Een specifiek recordexemplaren ophalen. Het geretourneerde recordobject vereist mogelijk extra parsering voordat u downstream in de werkstroom gebruikt. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM
Uitvoeringsinformatie ophalen

Een specifiek uitvoeringsexemplaren ophalen. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX

Alle documenten weergeven

Bewerkings-id:
documents_list

Een lijst met alle documenten die beschikbaar zijn op de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH

Retouren

Name Pad Type Description
count
 count integer

count
volgende
 next string

volgende
vorig
 previous string

vorig
results
 results array of Document

Alle gegevenssets weergeven

Bewerkings-id:
datasets_list

Geeft een lijst weer van alle gegevenssets die beschikbaar zijn voor de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR

Retouren

lijst met gegevenssets

PaginatedDatasetList
PaginatedDatasetList

Alle patronen weergeven

Bewerkings-id:
pipelines_list

Geef een lijst weer van alle patronen die beschikbaar zijn voor de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb

Retouren

lijst met pijplijnconfiguratie

PaginatedPipelineConfigurationList
PaginatedPipelineConfigurationList

Alle records weergeven

Bewerkings-id:
records_list

Een lijst met alle records die beschikbaar zijn voor de tenant. U kunt bijvoorbeeld alle records voor een specifiek patroon retourneren als de tenant is geconfigureerd met meerdere patronen. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs

Parameters

Name Sleutel Vereist Type Description
UUID van gegevensset
 dataset uuid

gegevensset uuid
Verwerkingsstatus
 document_status array

verwerkingsstatus
Patroon
 pipeline string

patroonnaam
Status verwijderd
 removed boolean

status verwijderd
Status gecontroleerd
 reviewed boolean

status gecontroleerd
Schema
 schema string

schema

Retouren

recordlijst

PaginatedRecordList
PaginatedRecordList

Alle uitvoeringen weergeven

Bewerkings-id:
executions_list

Geeft een lijst weer van alle uitvoeringen die beschikbaar zijn voor de tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g

Parameters

Name Sleutel Vereist Type Description
Documentstatus
 document_status array

documentstatus

Retouren

uitvoeringslijst

PaginatedExecutionList
PaginatedExecutionList

Documentbestand ophalen (oorspronkelijke indeling)

Bewerkings-id:
documents_download_original_retrieve

Hiermee downloadt u een kopie van het documentbestand dat in het Postvak IN van Data is geplaatst in de oorspronkelijke indeling.

Parameters

Name Sleutel Vereist Type Description
Document UUID
 uuid True uuid

document uuid

Retouren

response
binary

Documentbestand ophalen (PDF-indeling)

Bewerkings-id:
documents_download_pdf_retrieve

Hiermee downloadt u een kopie van het documentbestand dat in het Postvak IN van Data is geplaatst in een geconverteerde PDF-indeling.

Parameters

Name Sleutel Vereist Type Description
Document UUID
 uuid True uuid

document uuid

Retouren

response
binary

Documentbestand uploaden

Bewerkings-id:
documents_create

Uploadt een bestand naar een Data Inbox-tenant voor verwerking.

Parameters

Name Sleutel Vereist Type Description
Booleaanse waarde verwijderd
 removed boolean

Verwijderd
UUID van gegevensset
 dataset string

gegevensset uuid
Onderwerp
 subject string

Onderwerp
Afzender
 sender string

afzender
Map
 folder string

map
Bestandsnaam
 file True file

bestandsnaam
Gerichte patronen
 targets array

doelpatroonnamen

Documentgegevens ophalen

Bewerkings-id:
documents_retrieve

Een specifiek documentexemplaren ophalen. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh

Parameters

Name Sleutel Vereist Type Description
Document UUID
 uuid True uuid

document uuid

Retouren

document

Document
Document

Gegevenssetgegevens ophalen

Bewerkings-id:
datasets_retrieve

Een specifiek gegevenssetexemplaren ophalen. De geretourneerde gegevenssetrecord vereist mogelijk extra parsering voordat u downstream in de werkstroom gebruikt. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr

Parameters

Name Sleutel Vereist Type Description
UUID van gegevensset
 uuid True uuid

gegevensset uuid

Retouren

lijst met gegevenssets

PaginatedDatasetList
PaginatedDatasetList

Patroongegevens ophalen

Bewerkings-id:
pipelines_retrieve

Een specifiek patroonexemplaren ophalen. De geretourneerde patroonrecord kan extra parseren vereisen voordat u downstream in de werkstroom gebruikt.

Parameters

Name Sleutel Vereist Type Description
Patroonnaam
 name True string

patroonnaam

Retouren

pattern

PipelineConfiguration
PipelineConfiguration

Recordgegevens ophalen

Bewerkings-id:
records_retrieve

Een specifiek recordexemplaren ophalen. Het geretourneerde recordobject vereist mogelijk extra parsering voordat u downstream in de werkstroom gebruikt. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM

Parameters

Name Sleutel Vereist Type Description
UUID opnemen
 uuid True uuid

record uuid

Retouren

verslag / opname

Opnemen
Record

Uitvoeringsinformatie ophalen

Bewerkings-id:
executions_retrieve

Een specifiek uitvoeringsexemplaren ophalen. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX

Parameters

Name Sleutel Vereist Type Description
UUID uitvoeren
 uuid True uuid

uitvoering uuid

Retouren

uitvoering

Execution
Execution

Triggers

Wanneer een Alkymi-gebeurtenis wordt geactiveerd

Deze trigger wordt uitgevoerd wanneer een van de geselecteerde Alkymi-gebeurtenissen plaatsvindt.

Wanneer een Alkymi-gebeurtenis wordt geactiveerd

Bewerkings-id:
event_listener

Deze trigger wordt uitgevoerd wanneer een van de geselecteerde Alkymi-gebeurtenissen plaatsvindt.

Parameters

Name Sleutel Vereist Type Description
display_name
 display_name string

weergavenaam
Evenementen
 events array of string

webhook-gebeurtenissen

Retouren

webhook-gebeurtenis

WebhookEvent
WebHookEvent

Definities

Dataset

dataset

Name Pad Type Description
UUID (Universally Unique Identifier)
 uuid uuid
naam
 name string
pipeline
 pipeline string
Documenten
 documents string
archief
 records string

Document

document

Name Pad Type Description
UUID (Universally Unique Identifier)
 uuid string

UUID (Universally Unique Identifier)
geschapen
 created string

geschapen
modified
 modified string

modified
status
 status string

status
Gearchiveerde
 archived boolean

Gearchiveerde
Verwijderd
 removed boolean

Verwijderd
bestandsnaam
 file_name string

bestandsnaam
page_count
 page_count integer

aantal pagina's
pages
 pages array of object

pages
nummer
 pages.number integer

nummer
width
 pages.width integer

width
height
 pages.height integer

height
dataset
 dataset string

dataset
archief
 records array of

archief
pipeline_records
 pipeline_records object

pijplijnrecords
_s3_key
 _s3_key string

s3-sleutel
_replaced_by
 _replaced_by string

vervangen door
Onderwerp
 subject string

Onderwerp
afzender
 sender string

afzender
map
 folder string

map
watermark_removed
 watermark_removed boolean

watermerk verwijderd

Execution

uitvoering

Name Pad Type Description
UUID (Universally Unique Identifier)
 uuid uuid
geschapen
 created date-time
Herzien
 reviewed boolean
Gearchiveerde
 archived boolean
status
 status string
archief
 records array of string
pipeline_records
 pipeline_records object
bestandsnaam
 file_name string
Documenten
 documents array of string

PaginatedDatasetList

lijst met gegevenssets

Name Pad Type Description
count
 count integer
volgende
 next string
vorig
 previous string
results
 results array of Dataset

PaginatedExecutionList

uitvoeringslijst

Name Pad Type Description
count
 count integer
volgende
 next string
vorig
 previous string
results
 results array of Execution

PaginatedPipelineConfigurationList

lijst met pijplijnconfiguratie

Name Pad Type Description
count
 count integer
volgende
 next string
vorig
 previous string
results
 results array of PipelineConfiguration

PaginatedRecordList

recordlijst

Name Pad Type Description
count
 count integer
volgende
 next string
vorig
 previous string
results
 results array of Record

PipelineConfiguration

pattern

Name Pad Type Description
naam
 name string
archief
 records string
schemas
 schemas array of Schema

Opnemen

verslag / opname

Name Pad Type Description
UUID (Universally Unique Identifier)
 uuid uuid
geschapen
 created date-time
modified
 modified date-time
document_uuid
 document_uuid string
document
 document string
dataset
 dataset string
pipeline
 pipeline string
schema_name
 schema_name string
status
 status string
gegevens
 data object

Schema

schema

Name Pad Type Description
naam
 name string
primair
 primary boolean
velden
 fields array of SchemaField

SchemaField

Veld Schema

Name Pad Type Description
naam
 name string
field_type
 field_type string
sub_schema
 sub_schema string

WebHookEvent

webhook-gebeurtenis

Name Pad Type Description
UUID (Universally Unique Identifier)
 uuid string

UUID (Universally Unique Identifier)
status
 status string

status
geschapen
 created string

geschapen
archief
 records array of string

archief
Gearchiveerde
 archived boolean

Gearchiveerde
Herzien
 reviewed boolean

Herzien
Documenten
 documents array of string

Documenten
bestandsnaam
 file_name string

bestandsnaam
pipeline_records
 pipeline_records object

pijplijnrecords
trigger_event_list
 trigger_event_list array of string

lijst met trigger-gebeurtenissen

binair

Dit is het basisgegevenstype 'binair'.