AIForged (preview)
AIForged is een intelligente oplossing voor documentverwerking voor complexe problemen. AIForged kan de verwerking en extractie van gestructureerde gegevens uit ongestructureerde afbeeldingen automatiseren. De connector biedt integratie en automatisering van intellegente documentextractie met AIForged
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 | AIForged |
| URL | https://www.aiforged.com |
| E-mailen | support@aiforged.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Larc AI (PTY) Ltd |
| Webpagina | https://www.aiforged.com |
| Privacybeleid | https://portal.aiforged.com/privacypolicy.html |
| Categorieën | AI; Inhoud en bestanden |
AIForged is een cloudoplossing voor intelligente documentverwerking voor het oplossen van complexe problemen met documentextractie. Het AIForged-platform integreert naadloos meerdere services in één model van toonaangevende AI-services zoals Microsoft, Google, Amazon, ABBYY, zodat u deze services tegelijk kunt gebruiken voor optimale resultaten. AiForged Intelligent Document Processing stelt bedrijven in staat hun uitvoer te verhogen, met een grotere nauwkeurigheid, een hogere snelheid tegen lagere kosten.
Vereiste voorwaarden
U hebt het volgende nodig:
Een Microsoft Power Apps- of Power Automate-abonnement
U hebt een Microsoft 365-account, een Power Automate-abonnement en AIForged-account/-service nodig.
Een AIForged-account en -service
Als u deze connector wilt gebruiken, hebt u een AIForged-account nodig. U moet ook de AIForged-service configureren en trainen voor nauwkeurige resultaten. Voor meer instructies registreert u zich bij AIForged en stelt u een AIForged-project en -service in door de stappen te volgen die zijn gedefinieerd in Een project maken.
Hier volgt een praktisch voorbeeld over het extraheren van informatie uit burgerservicekaarten Practicle Example - Social Security.
Zie ook ons praktische voorbeeld voor het extraheren van informatie uit krediettoepassingen Praktisch voorbeeld - krediettoepassing.
Referenties ophalen
Er is een AIForged-account nodig om AIForged te gebruiken. U kunt zich registreren door de AIForged-app te installeren vanuit de Microsoft Store of Microsoft Store-website.
Zodra de app is geïnstalleerd, kunt u zich registreren met behulp van de eenvoudige registratiestappen Registreren.
Als u het account wilt activeren, ontvangt u een e-mail met de activeringskoppeling. Zodra u op de activeringskoppeling klikt, wordt AIForged geopend met activeringsgegevens. Zodra uw account is geactiveerd, kunt u zich aanmelden met uw referenties en vervolgens uw referenties in uw connector gebruiken.
Een AIForged-service maken en trainen
Eerst moet u een projectcontainer maken voor factureringsdoeleinden. Zodra uw project is gemaakt, kunt u een intelligente service toevoegen door de wizardstappen in de AIForged-toepassing te volgen.
Hier volgt een lijst met praktijkvoorbeelden voor het extraheren van informatie uit documenten
Praktijkvoorbeeld: burgerservicekaarten.
Praktisch voorbeeld - Bankafschriften.
Praktisch voorbeeld: krediettoepassing.
Aan de slag met uw connector
Zie de volgende handleiding voor Power Automate - Aan de slag voor meer informatie over de aan de slag
Authenticatie
Deze connector maakt gebruik van OAuth2 verificatie (zie de bovenstaande stappen voor het verkrijgen van een connector). Wanneer u een nieuwe connector maakt (in Power Apps/Logic Apps), moet u verificatiegegevens opgeven uit de registratie.
Bekende problemen en beperkingen
U kunt MFA/2FA niet inschakelen voor de referenties die u in de connector gebruikt.
Veelvoorkomende fouten en oplossingen
Voor ondersteuning of hulp maakt u een ondersteuningsticket bij AIForged Support of stuurt u een e-mail naar support@aiforged.com
Veelgestelde vragen
Zie de documentatie voor AIForged voor meer informatie en veelgestelde vragen.
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Alle categorieën ophalen per project |
Alle categorieën ophalen per project |
| API-sleutel voor een gebruiker ophalen |
API-sleutel voor een gebruiker ophalen |
| Blob ophalen op blobsleutel |
Blob ophalen op blobsleutel |
| Bovenliggende service ophalen voor een parameterdef op id |
Bovenliggende service ophalen voor een parameterdef op id |
| Classificatie-informatie ophalen |
Classificatie-informatie ophalen |
| De gegevensblob ophalen voor een document-id op afbeeldingstype |
De gegevensblob ophalen voor een document-id op afbeeldingstype |
| De huidige servicegegevens en -tijd ophalen |
De huidige servicegegevens en -tijd ophalen |
| De meest recente verificatie voor een parameter ophalen |
De meest recente verificatie voor een parameter ophalen |
| Definitie ophalen op id |
Definitie ophalen op id |
| Documentafbeeldingen ophalen |
Documentafbeeldingen ophalen |
| Documentafbeeldingen ophalen |
Documentafbeeldingen ophalen |
| Documenten zoeken met behulp van gestructureerde zoekcriteria. De resultaten kunnen worden gepaginad |
Documenten zoeken met behulp van gestructureerde zoekcriteria. De resultaten kunnen worden gepaginad |
| Documentparameters extraheren |
Documentparameters extraheren |
| Een document en de bijbehorende documenten ophalen |
Een document en de bijbehorende documenten ophalen |
| Een document ophalen op id |
Een document ophalen op id |
| Een document uploaden en classificeren |
Een document uploaden en classificeren |
| Een document verwijderen op id |
Een document verwijderen op id |
| Een documentblob verwijderen |
Een documentblob verwijderen |
| Een parameter ophalen op basis van verificatie-id |
Een parameter ophalen op basis van verificatie-id |
| Een parameter verwijderen |
Een parameter verwijderen |
| Een project zoeken op naam |
Een project zoeken op naam |
| Een samenvatting van verificaties ophalen |
Een samenvatting van verificaties ophalen |
| Een samenvatting van verificaties ophalen |
Een samenvatting van verificaties ophalen |
| Een service ophalen op id |
Een service ophalen op id |
| Een specifiek project ophalen |
Een specifiek project ophalen |
| Een verificatie-installatiekopie ophalen |
Een verificatie-installatiekopie ophalen |
| Een verificatie ophalen op basis van id |
Een verificatie ophalen op basis van id |
| Gegevenstypen ophalen |
Gegevenstypen ophalen |
| Hiërarchie van velden ophalen voor alle services in een project |
Hiërarchie van velden ophalen voor alle services in een project |
| Hiërarchie van velden voor een service ophalen |
Hiërarchie van velden voor een service ophalen |
| Huidige aangemelde gebruiker ophalen |
Huidige aangemelde gebruiker ophalen |
| Informatie voor verificatie uploaden en extraheren |
Informatie voor verificatie uploaden en extraheren |
| Ophalen per gebruiker en project |
Ophalen per gebruiker en project |
| Parameterhiërarchie ophalen |
Parameterhiërarchie ophalen |
| Parameterwaarde ophalen |
Parameterwaarde ophalen |
| Projecten en services ophalen die zijn gekoppeld aan een gebruiker |
Projecten en services ophalen die zijn gekoppeld aan een gebruiker |
| Services ophalen die betrekking hebben op een project |
Services ophalen die betrekking hebben op een project |
| Systeem- en toepassingsgegevens ophalen |
Systeem- en toepassingsgegevens ophalen |
| Systeem-enumwaarden ophalen |
Systeem-enumwaarden ophalen |
| Uploaden: een documentclassificatie ophalen |
Uploaden: een documentclassificatie ophalen |
| Verificatieanalyse ophalen |
Verificatieanalyse ophalen |
| Verificaties ophalen voor een parameter |
Verificaties ophalen voor een parameter |
| Voorbeelddocumenten en afbeeldingen voor een service ophalen |
Voorbeelddocumenten en afbeeldingen voor een service ophalen |
Alle categorieën ophalen per project
Alle categorieën ophalen per project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De id van het ptoject
|
projectId | integer |
De id van het ptoject |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
API-sleutel voor een gebruiker ophalen
API-sleutel voor een gebruiker ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruikers-id
|
userId | string |
De gebruikers-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
- response
- string
Blob ophalen op blobsleutel
Blob ophalen op blobsleutel
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De blob-id
|
id | integer |
De blob-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
- response
- file
Bovenliggende service ophalen voor een parameterdef op id
Bovenliggende service ophalen voor een parameterdef op id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De parameterdefinitie-id
|
id | integer |
De parameterdefinitie-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Service, instellingen abd-regelsdefinities
Classificatie-informatie ophalen
Classificatie-informatie ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De id van de classificatie
|
Id | integer |
De id van de classificatie |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Categorieën/klassen voor training en classificatie
De gegevensblob ophalen voor een document-id op afbeeldingstype
De gegevensblob ophalen voor een document-id op afbeeldingstype
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-id die eigenaar is van het document
|
userId | string |
Gebruikers-id die eigenaar is van het document |
|
|
Blob-id
|
id | integer |
Blob-id |
|
|
Het blobtype
|
type | integer |
Het blobtype |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
- response
- file
De huidige servicegegevens en -tijd ophalen
De huidige servicegegevens en -tijd ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
- response
- date-time
De meest recente verificatie voor een parameter ophalen
De meest recente verificatie voor een parameter ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
docId | integer |
Document-id |
|
|
Parameter-id
|
parameterId | integer |
Parameter-id |
|
|
Definitie-id
|
pdId | integer |
Definitie-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Systeem- en gebruikersverificatiegegevens voor velden in documenten
Definitie ophalen op id
Definitie ophalen op id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De definitie-id
|
id | integer |
De definitie-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Service, instellingen abd-regelsdefinities
Documentafbeeldingen ophalen
Documentafbeeldingen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De document-id
|
id | integer |
De document-id |
|
|
Service-id
|
stpdId | integer |
Service-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Documentafbeeldingen ophalen
Documentafbeeldingen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
id | integer |
Document-id |
|
|
Afbeeldingstype
|
type | integer |
Afbeeldingstype |
|
|
Inhoudstype afbeelding
|
contentType | string |
Inhoudstype afbeelding |
|
|
Een testfilter
|
text | string |
Een testfilter |
|
|
De gerelateerde blob-id
|
blobid | integer |
De gerelateerde blob-id |
|
|
De pagina-index
|
pageindex | integer |
De pagina-index |
|
|
Aantal te retourneren afbeeldingen
|
imagesCount | integer |
Aantal te retourneren afbeeldingen |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Documenten zoeken met behulp van gestructureerde zoekcriteria. De resultaten kunnen worden gepaginad
Documenten zoeken met behulp van gestructureerde zoekcriteria. De resultaten kunnen worden gepaginad
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Eigenaar van het document
|
userId | string |
Eigenaar van het document |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
De map of het gebruik
|
usage | integer |
De map of het gebruik |
|
|
De status
|
status | integer |
De status |
|
|
Een klassenaamfilter
|
classname | string |
Een klassenaamfilter |
|
|
Bestandsnaamfilter
|
filename | string |
Bestandsnaamfilter |
|
|
Bestandstypefilter
|
filetype | string |
Bestandstypefilter |
|
|
Begindatumbereik voor documenten
|
start | date-time |
Begindatumbereik voor documenten |
|
|
Einddatumbereik voor documenten
|
end | date-time |
Einddatumbereik voor documenten |
|
|
Hoofd- of bovenliggende element van het document
|
masterid | integer |
Hoofd- of bovenliggende element van het document |
|
|
Paginanummer
|
pageNo | integer |
Paginanummer |
|
|
Grootte van een pagina
|
pageSize | integer |
Grootte van een pagina |
|
|
Sorteren op veld
|
sortField | integer |
Sorteren op veld |
|
|
Sorteerrichting op basis van het sorteerveld
|
sortDirection | integer |
Sorteerrichting op basis van het sorteerveld |
|
|
Filteren op opmerkingen
|
comment | string |
Filteren op opmerkingen |
|
|
Filteren op resultaten
|
result | string |
Filteren op resultaten |
|
|
Filteren op een resultaat-id
|
resultId | string |
Filteren op een resultaat-id |
|
|
Filteren op resultaatindex
|
resultIndex | integer |
Filteren op resultaatindex |
|
|
Filteren op externe id's
|
externalId | string |
Filteren op externe id's |
|
|
Filteren op document-GUID's
|
docGuid | string |
Filteren op document-GUID's |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Documentparameters extraheren
Documentparameters extraheren
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De document-id
|
docid | integer |
De document-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Een document en de bijbehorende documenten ophalen
Een document en de bijbehorende documenten ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
id | integer |
Document-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Metagegevens van documenten
Een document ophalen op id
Een document ophalen op id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De document-id
|
id | integer |
De document-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Metagegevens van documenten
Een document uploaden en classificeren
Een document uploaden en classificeren
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
Project-id
|
projectId | integer |
Project-id |
|
|
De bestandsgegevens
|
file | file |
De bestandsgegevens |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Metagegevens van documenten
Een document verwijderen op id
Een document verwijderen op id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id die moet worden verwijderd
|
id | integer |
Document-id die moet worden verwijderd |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Metagegevens van documenten
Een documentblob verwijderen
Een documentblob verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De blob-id
|
id | integer |
De blob-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
- response
- file
Een parameter ophalen op basis van verificatie-id
Een parameter ophalen op basis van verificatie-id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De verificatie-id
|
verificationId | integer |
De verificatie-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Veldenwaarden gekoppeld aan geëxtraheerd uit documenten
Een parameter verwijderen
Een parameter verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De parameter-id
|
paramid | integer |
De parameter-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Veldenwaarden gekoppeld aan geëxtraheerd uit documenten
Een project zoeken op naam
Een project zoeken op naam
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruikers-id
|
userId | string |
De gebruikers-id |
|
|
Projectnaam
|
projectName | string |
Projectnaam |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Projecten is een container voor facturering en services
Een samenvatting van verificaties ophalen
Een samenvatting van verificaties ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De project-id
|
projectId | integer |
De project-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Een samenvatting van verificaties ophalen
Een samenvatting van verificaties ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Project-id
|
projectId | integer |
Project-id |
|
|
Service-id
|
stpdId | integer |
Service-id |
|
|
Definitie-id
|
pdId | integer |
Definitie-id |
|
|
Alleen meest recente of geschiedenis
|
latestOnly | boolean |
Alleen meest recente of geschiedenis |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Een service ophalen op id
Een service ophalen op id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Service, instellingen abd-regelsdefinities
Een specifiek project ophalen
Een specifiek project ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruikers-id
|
userId | string |
De gebruikers-id |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Projecten is een container voor facturering en services
Een verificatie-installatiekopie ophalen
Een verificatie-installatiekopie ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruiker voor de versnipperde
|
userId | string |
Gebruiker voor de versnipperde |
|
|
Document-id
|
docId | integer |
Document-id |
|
|
Parameter-id
|
parId | integer |
Parameter-id |
|
|
Verificatie-id
|
verificationId | integer |
Verificatie-id |
|
|
Moet de afbeelding inline zijn
|
inline | boolean |
Moet de afbeelding inline zijn |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
- response
- file
Een verificatie ophalen op basis van id
Een verificatie ophalen op basis van id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Verificatie-id
|
verificationId | integer |
Verificatie-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Systeem- en gebruikersverificatiegegevens voor velden in documenten
Gegevenstypen ophalen
Gegevenstypen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Hiërarchie van velden ophalen voor alle services in een project
Hiërarchie van velden ophalen voor alle services in een project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruikers-id
|
userId | string |
De gebruikers-id |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
De groeps-id
|
groupId | integer |
De groeps-id |
|
|
Tellerstatistieken opnemen
|
includeCount | boolean |
Tellerstatistieken opnemen |
|
|
Alleen services opnemen
|
onlyServices | boolean |
Alleen services opnemen |
|
|
Instellingen opnemen
|
includeSettings | boolean |
Instellingen opnemen |
|
|
Kinderen opnemen
|
includeChildren | boolean |
Kinderen opnemen |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Hiërarchie van velden voor een service ophalen
Hiërarchie van velden voor een service ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De project-id
|
projectId | integer |
De project-id |
|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
Tellerstatistieken opnemen
|
includeCount | boolean |
Tellerstatistieken opnemen |
|
|
Instellingen opnemen
|
includeSettings | boolean |
Instellingen opnemen |
|
|
Onderliggende definiities opnemen
|
includeChildren | boolean |
Onderliggende definiities opnemen |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Service, instellingen abd-regelsdefinities
Huidige aangemelde gebruiker ophalen
Huidige aangemelde gebruiker ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Gebruikersgegevens
Informatie voor verificatie uploaden en extraheren
Informatie voor verificatie uploaden en extraheren
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
Het bestand
|
file | file |
Het bestand |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Metagegevens van documenten
Ophalen per gebruiker en project
Ophalen per gebruiker en project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruikers-id
|
userId | string |
De gebruikers-id |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Parameterhiërarchie ophalen
Parameterhiërarchie ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De document-id
|
docId | integer |
De document-id |
|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
Verificatiegegevens opnemen
|
includeverification | boolean |
Verificatiegegevens opnemen |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Parameterwaarde ophalen
Parameterwaarde ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De document-id
|
docId | integer |
De document-id |
|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
Parametercategorie
|
category | integer |
Parametercategorie |
|
|
Parametergroepering
|
grouping | integer |
Parametergroepering |
|
|
Verificatiegegevens opnemen
|
includeverification | boolean |
Verificatiegegevens opnemen |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Projecten en services ophalen die zijn gekoppeld aan een gebruiker
Projecten en services ophalen die zijn gekoppeld aan een gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruikers-id
|
userId | string |
De gebruikers-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Services ophalen die betrekking hebben op een project
Services ophalen die betrekking hebben op een project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruikers-id
|
userId | string |
De gebruikers-id |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
Filter voor servicetype
|
stlfilter | integer |
Filter voor servicetype |
|
|
Filteren op engine
|
enginefilter | string |
Filteren op engine |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Systeem- en toepassingsgegevens ophalen
Systeem- en toepassingsgegevens ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
- response
- object
Systeem-enumwaarden ophalen
Systeem-enumwaarden ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Uploaden: een documentclassificatie ophalen
Uploaden: een documentclassificatie ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
De document-id
|
docId | integer |
De document-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Categorieën/klassen voor training en classificatie
Verificatieanalyse ophalen
Verificatieanalyse ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De project-id
|
projectId | integer |
De project-id |
|
|
Service-id
|
stpdId | integer |
Service-id |
|
|
Alleen de meest recente
|
latestOnly | boolean |
Alleen de meest recente |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Verificaties ophalen voor een parameter
Verificaties ophalen voor een parameter
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
docId | integer |
Document-id |
|
|
Parameter-id
|
parameterId | integer |
Parameter-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Voorbeelddocumenten en afbeeldingen voor een service ophalen
Voorbeelddocumenten en afbeeldingen voor een service ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De gebruiker die eigenaar is van de service
|
userId | string |
De gebruiker die eigenaar is van de service |
|
|
De project-id
|
projectId | integer |
De project-id |
|
|
De service-id
|
stpdId | integer |
De service-id |
|
|
API-versieheader
|
X-Api-Version | True | string |
API-versieheader |
Retouren
Definities
AIForged.ViewModels.UserViewModel
Gebruikersgegevens
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string | |
|
gebruikersnaam
|
userName | string | |
|
fullName
|
fullName | string | |
|
e-mailadres
|
|||
|
functietitel
|
jobTitle | string | |
|
telefoonnummer
|
phoneNumber | phone | |
|
configuratie
|
configuration | string | |
|
isIngeschakeld
|
isEnabled | boolean | |
|
isLockedOut
|
isLockedOut | boolean | |
|
friendlyName
|
friendlyName | string | |
|
gemaakt door
|
createdBy | string | |
|
bijgewerktDoor
|
updatedBy | string | |
|
aanmaakdatum
|
createdDate | date-time | |
|
updatedDate
|
updatedDate | date-time | |
|
roles
|
roles | array of string |
AIForged.ViewModels.ClassesViewModel
Categorieën/klassen voor training en classificatie
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
userId
|
userId | string | |
|
project-id
|
projectId | integer | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
reactie
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
type
|
type | AIForged.DAL.ClassType |
Type systeemcategorie |
|
aanverwant
|
related | integer |
AIForged.DAL.ClassType
AIForged.ViewModels.DocumentViewModel
Metagegevens van documenten
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
userId
|
userId | string | |
|
project-id
|
projectId | integer | |
|
service-ID
|
serviceId | integer | |
|
status
|
status | AIForged.DAL.DocumentStatus |
De status van een document in het systeem aangeven |
|
usage
|
usage | AIForged.DAL.UsageType |
Waarom slaan we dit document op |
|
classId
|
classId | integer | |
|
inhoudstype
|
contentType | string | |
|
filename
|
filename | string | |
|
fileType
|
fileType | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
documentId
|
documentId | guid | |
|
externId
|
externalId | string | |
|
masterId
|
masterId | integer | |
|
resultaat
|
result | string | |
|
resultId
|
resultId | string | |
|
resultIndex
|
resultIndex | integer | |
|
reactie
|
comment | string | |
|
availability
|
availability | AIForged.DAL.Availability |
Beschikbaarheid van een record |
|
resultParameters
|
resultParameters | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
gegevens
|
data | array of AIForged.ViewModels.DocumentDataViewModel | |
|
Documenten
|
documents | array of AIForged.ViewModels.DocumentViewModel | |
|
oorsprong-ID
|
originId | integer | |
|
canVerify
|
canVerify | boolean | |
|
canClassify
|
canClassify | boolean | |
|
canTrain
|
canTrain | boolean | |
|
getraind
|
trained | boolean | |
|
linkedDocsCount
|
linkedDocsCount | integer | |
|
trainingFieldCount
|
trainingFieldCount | integer | |
|
trainedParametersCount
|
trainedParametersCount | integer |
AIForged.DAL.DocumentStatus
De status van een document in het systeem aangeven
De status van een document in het systeem aangeven
AIForged.DAL.UsageType
AIForged.DAL.Availability
AIForged.ViewModels.DocumentParameterViewModel
Veldenwaarden gekoppeld aan geëxtraheerd uit documenten
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
documentId
|
documentId | integer | |
|
paramDefId
|
paramDefId | integer | |
|
ouder-ID
|
parentId | integer | |
|
bron-id
|
sourceId | integer | |
|
waarde
|
value | string | |
|
gegevens
|
data | byte | |
|
index
|
index | integer | |
|
colIndex
|
colIndex | integer | |
|
colSpan
|
colSpan | integer | |
|
rowIndex
|
rowIndex | integer | |
|
rijSpan
|
rowSpan | integer | |
|
availability
|
availability | AIForged.DAL.Availability |
Beschikbaarheid van een record |
|
paramDef
|
paramDef |
Service, instellingen abd-regelsdefinities |
|
|
kinderen
|
children | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
Verificaties
|
verifications | array of AIForged.ViewModels.VerificationViewModel |
AIForged.ViewModels.ParameterDefViewModel
Service, instellingen abd-regelsdefinities
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
project-id
|
projectId | integer | |
|
serviceTypeId
|
serviceTypeId | integer | |
|
service-ID
|
serviceId | integer | |
|
classId
|
classId | integer | |
|
ouder-ID
|
parentId | integer | |
|
naam
|
name | string | |
|
label
|
label | string | |
|
tags
|
tags | string | |
|
beschrijving
|
description | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
status
|
status | AIForged.DAL.ParameterDefinitionStatus |
Status van definitie |
|
category
|
category | AIForged.DAL.ParameterDefinitionCategory |
Categorie van definitie |
|
groepering
|
grouping | AIForged.DAL.GroupingType |
Type veldgroepering |
|
valueType
|
valueType | AIForged.DAL.ValueType |
Het type waarden dat wordt gebruikt voor regels en instellingen |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
required
|
required | AIForged.DAL.RequiredOption |
Geef aan of een optie is vereist |
|
index
|
index | integer | |
|
info
|
info | string | |
|
referentie
|
reference | string | |
|
Rating
|
rating | float | |
|
availability
|
availability | AIForged.DAL.Availability |
Beschikbaarheid van een record |
|
kinderen
|
children | array of AIForged.ViewModels.ParameterDefViewModel | |
|
settings
|
settings | array of AIForged.DAL.Models.ParameterDefSettingViewModel | |
|
totalCharge
|
totalCharge | double | |
|
gebruikersaantal
|
userCount | integer | |
|
parameterCount
|
parameterCount | integer | |
|
documentCount
|
documentCount | integer | |
|
validering
|
validation | string |
AIForged.DAL.ParameterDefinitionStatus
AIForged.DAL.ParameterDefinitionCategory
AIForged.DAL.GroupingType
AIForged.DAL.ValueType
Het type waarden dat wordt gebruikt voor regels en instellingen
Het type waarden dat wordt gebruikt voor regels en instellingen
AIForged.DAL.RequiredOption
AIForged.DAL.Models.ParameterDefSettingViewModel
Gedetailleerde instellingen voor regels en instellingen
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
parameterDefId
|
parameterDefId | integer | |
|
type
|
type | AIForged.DAL.SettingType |
Het type instelling dat is gerelateerd aan een parameter |
|
status
|
status | AIForged.DAL.SettingStatus |
De status van een instelling die is gerelateerd aan een parameter |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
reactie
|
comment | string | |
|
info
|
info | string | |
|
gegevens
|
data | string | |
|
minimumwaarde
|
minValue | string | |
|
maxWaarde
|
maxValue | string | |
|
vertrouwen
|
confidence | float | |
|
minConfidence
|
minConfidence | float | |
|
maxConfidence
|
maxConfidence | float | |
|
isCaseSensative
|
isCaseSensative | boolean | |
|
omkeren
|
invert | boolean | |
|
oneLine
|
oneLine | boolean | |
|
oneWord
|
oneWord | boolean | |
|
isHandwriting
|
isHandwriting | boolean | |
|
oriëntatie
|
orientation | AIForged.DAL.Orientation |
Tekstrichting van een veld |
|
Markering
|
marking | AIForged.DAL.MarkingType |
Type tekst markeren |
|
Cellen
|
cells | integer | |
|
clearBefore
|
clearBefore | AIForged.DAL.OptionStatusFlags |
Statusvlag van opties |
|
clearAfter
|
clearAfter | AIForged.DAL.OptionStatusFlags |
Statusvlag van opties |
|
cleanupValuesBefore
|
cleanupValuesBefore | boolean | |
|
cleanupValuesAfter
|
cleanupValuesAfter | boolean | |
|
validateValuesBefore
|
validateValuesBefore | boolean | |
|
validateValuesAfter
|
validateValuesAfter | boolean | |
|
abortOnValidationError
|
abortOnValidationError | boolean | |
|
isReplacementCaseSensative
|
isReplacementCaseSensative | boolean | |
|
compileResults
|
compileResults | string | |
|
maxRetry
|
maxRetry | integer | |
|
timeout
|
timeout | string | |
|
userId
|
userId | string |
AIForged.DAL.SettingType
Het type instelling dat is gerelateerd aan een parameter
Het type instelling dat is gerelateerd aan een parameter
AIForged.DAL.SettingStatus
De status van een instelling die is gerelateerd aan een parameter
De status van een instelling die is gerelateerd aan een parameter
AIForged.DAL.Orientation
AIForged.DAL.MarkingType
AIForged.DAL.OptionStatusFlags
AIForged.ViewModels.VerificationViewModel
Systeem- en gebruikersverificatiegegevens voor velden in documenten
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
parameterId
|
parameterId | integer | |
|
userId
|
userId | string | |
|
waarde
|
value | string | |
|
Dt
|
dt | date-time | |
|
vertrouwen
|
confidence | float | |
|
symbolsConfidence
|
symbolsConfidence | string | |
|
type
|
type | AIForged.DAL.VerificationType |
Type verificatie |
|
status
|
status | AIForged.DAL.VerificationStatus |
Verificatiestatusvlagmen |
|
resultaat
|
result | string | |
|
doos
|
box | string | |
|
info
|
info | string | |
|
gegevens
|
data | byte | |
|
gebruikersnaam
|
userName | string | |
|
service-ID
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
provider
|
provider | string | |
|
settingId
|
settingId | integer | |
|
workItem
|
workItem | integer | |
|
transactie-ID
|
transactionId | integer | |
|
aanklacht
|
charge | double |
AIForged.DAL.VerificationType
AIForged.DAL.VerificationStatus
AIForged.ViewModels.DocumentDataViewModel
Documentblobgegevens
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
documentId
|
documentId | integer | |
|
blobId
|
blobId | integer | |
|
type
|
type | AIForged.DAL.DocumentDataType |
Het type gegevens aangeven dat betrekking heeft op een document |
|
gegevens
|
data | byte | |
|
voorvertoning
|
preview | byte | |
|
Tekst
|
text | string | |
|
info
|
info | string | |
|
inhoudstype
|
contentType | string | |
|
resultId
|
resultId | string | |
|
index
|
index | integer | |
|
width
|
width | double | |
|
height
|
height | double | |
|
resolutie
|
resolution | double | |
|
availability
|
availability | AIForged.DAL.Availability |
Beschikbaarheid van een record |
AIForged.DAL.DocumentDataType
Het type gegevens aangeven dat betrekking heeft op een document
Het type gegevens aangeven dat betrekking heeft op een document
AIForged.ViewModels.DocParamSummary
Documentoverzicht voor statistieken met informatie over parameters
| Name | Pad | Type | Description |
|---|---|---|---|
|
project-id
|
projectId | integer | |
|
serviceType
|
serviceType | integer | |
|
service-ID
|
serviceId | integer | |
|
usage
|
usage | AIForged.DAL.UsageType |
Waarom slaan we dit document op |
|
status
|
status | AIForged.DAL.DocumentStatus |
De status van een document in het systeem aangeven |
|
naam
|
name | string | |
|
classId
|
classId | integer | |
|
className
|
className | string | |
|
serviceName
|
serviceName | string | |
|
fileType
|
fileType | string | |
|
Dt
|
dt | date-time | |
|
count
|
count | integer | |
|
labeldCount
|
labelledCount | integer | |
|
pdId
|
pdId | integer | |
|
paramDefName
|
paramDefName | string | |
|
category
|
category | AIForged.DAL.ParameterDefinitionCategory |
Categorie van definitie |
|
groepering
|
grouping | AIForged.DAL.GroupingType |
Type veldgroepering |
|
valueType
|
valueType | AIForged.DAL.ValueType |
Het type waarden dat wordt gebruikt voor regels en instellingen |
|
waarde
|
value | string | |
|
index
|
index | integer |
AIForged.ViewModels.DocumentExtraction
Getransponeerde extractie van gestructureerde documentresultaten
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
ouder-ID
|
parentId | integer | |
|
naam
|
name | string | |
|
label
|
label | string | |
|
category
|
category | AIForged.DAL.ParameterDefinitionCategory |
Categorie van definitie |
|
groepering
|
grouping | AIForged.DAL.GroupingType |
Type veldgroepering |
|
valueType
|
valueType | AIForged.DAL.ValueType |
Het type waarden dat wordt gebruikt voor regels en instellingen |
|
index
|
index | integer | |
|
paramId
|
paramId | integer | |
|
parentParamId
|
parentParamId | integer | |
|
paramIndex
|
paramIndex | integer | |
|
paramValue
|
paramValue | string | |
|
verificationId
|
verificationId | integer | |
|
userId
|
userId | string | |
|
gebruikersnaam
|
userName | string | |
|
waarde
|
value | string | |
|
Dt
|
dt | date-time | |
|
vertrouwen
|
confidence | float | |
|
type
|
type | AIForged.DAL.VerificationType |
Type verificatie |
|
status
|
status | AIForged.DAL.VerificationStatus |
Verificatiestatusvlagmen |
|
aanklacht
|
charge | double | |
|
provider
|
provider | string | |
|
resultaat
|
result | string |
AIForged.ViewModels.ProjectViewModel
Projecten is een container voor facturering en services
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
userId
|
userId | string | |
|
status
|
status | AIForged.DAL.ProjectStatus |
Wordt gebruikt om de status van een project aan te geven |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
reactie
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
evenwicht
|
balance |
Boekhoudgegevens voor projecten en services |
|
|
totalDocsCount
|
totalDocsCount | integer | |
|
services
|
services | array of AIForged.ViewModels.ParameterDefViewModel |
AIForged.DAL.ProjectStatus
Wordt gebruikt om de status van een project aan te geven
Wordt gebruikt om de status van een project aan te geven
AIForged.ViewModels.DataTypeViewModel
Gegevenstypen die worden gebruikt voor regels en interne verwerking
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | AIForged.DAL.ValueType |
Het type waarden dat wordt gebruikt voor regels en instellingen |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
category
|
category | AIForged.DAL.DataTypeCategory |
De categorie gegevenstypen |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
gegevens
|
data | string |
AIForged.DAL.DataTypeCategory
AIForged.ViewModels.EnumDataViewModel
Lijst met systeem-enums en basisinformatie over de gebruikersinterface
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
type
|
type | AIForged.DAL.EnumType |
Opsomming van alle opsommingen in het systeem |
|
typeNaam
|
typeName | string | |
|
naam
|
name | string | |
|
waarde
|
value | integer | |
|
beschrijving
|
description | string | |
|
info
|
info | string | |
|
icon
|
icon | string | |
|
color
|
color | string |
AIForged.DAL.EnumType
AIForged.ViewModels.VerificationSummary
Systeem- en gebruikersverificatiegegevens voor velden in documenten
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | integer | |
|
parameterId
|
parameterId | integer | |
|
userId
|
userId | string | |
|
waarde
|
value | string | |
|
Dt
|
dt | date-time | |
|
vertrouwen
|
confidence | float | |
|
symbolsConfidence
|
symbolsConfidence | string | |
|
type
|
type | AIForged.DAL.VerificationType |
Type verificatie |
|
status
|
status | AIForged.DAL.VerificationStatus |
Verificatiestatusvlagmen |
|
resultaat
|
result | string | |
|
doos
|
box | string | |
|
info
|
info | string | |
|
gegevens
|
data | byte | |
|
gebruikersnaam
|
userName | string | |
|
service-ID
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
provider
|
provider | string | |
|
settingId
|
settingId | integer | |
|
workItem
|
workItem | integer | |
|
transactie-ID
|
transactionId | integer | |
|
aanklacht
|
charge | double | |
|
paramDefId
|
paramDefId | integer | |
|
paramDefName
|
paramDefName | string | |
|
project-id
|
projectId | integer | |
|
projectNaam
|
projectName | string | |
|
docId
|
docId | integer | |
|
docFileName
|
docFileName | string | |
|
docContentType
|
docContentType | string | |
|
docUsage
|
docUsage | AIForged.DAL.UsageType |
Waarom slaan we dit document op |
|
docStatus
|
docStatus | AIForged.DAL.DocumentStatus |
De status van een document in het systeem aangeven |
|
classId
|
classId | integer | |
|
className
|
className | string | |
|
jaar
|
year | integer | |
|
maand
|
month | integer | |
|
day
|
day | integer | |
|
dagVanDeWeek
|
dayOfWeek | System.DayOfWeek |
De kalenderdag van de week |
|
count
|
count | integer | |
|
gemiddeld
|
average | float | |
|
min
|
min | float | |
|
max
|
max | float |
System.DayOfWeek
bestand
Dit is het basisgegevenstype 'bestand'.
touw
Dit is het basisgegevenstype 'tekenreeks'.
Voorwerp
Dit is het type 'object'.