Udostępnij przez


AIForged (wersja zapoznawcza)

AIForged to inteligentne rozwiązanie do przetwarzania dokumentów ze złożonymi problemami. Usługa AIForged umożliwia zautomatyzowanie przetwarzania i wyodrębniania ustrukturyzowanych danych z obrazów bez struktury. Łącznik zapewnia integrację i automatyzację wyodrębniania dokumentów intellegent za pomocą interfejsu AIForged

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name AIForged
adres URL https://www.aiforged.com
Email support@aiforged.com
Metadane łącznika
Publisher Larc AI (PTY) Ltd
Witryna internetowa https://www.aiforged.com
Zasady ochrony prywatności https://portal.aiforged.com/privacypolicy.html
Kategorie AI; Zawartość i pliki

AIForged to oparte na chmurze rozwiązanie inteligentnego przetwarzania dokumentów do rozwiązywania złożonych problemów z wyodrębnianiem dokumentów. Platforma AIForged bezproblemowo integruje wiele usług z jednym modelem z wiodących w branży usług sztucznej inteligencji, takich jak Microsoft, Google, Amazon, ABBYY, zapewniając możliwość korzystania z tych usług w parze w celu uzyskania optymalnych wyników. AIForged Intelligent Document Processing (Inteligentne przetwarzanie dokumentów) umożliwia firmom zwiększenie ich danych wyjściowych z większą dokładnością i większą szybkością przy niższych kosztach.

Wymagania wstępne

Potrzebne są następujące elementy:

Plan usługi Microsoft Power Apps lub Power Automate

Potrzebujesz konta platformy Microsoft 365, planu usługi Power Automate i usługi AIForged.

Konto i usługa AIForged

Aby użyć tego łącznika, musisz mieć konto AIForged. Należy również skonfigurować i wytrenować usługę AIForged, aby uzyskać dokładne wyniki. Aby uzyskać więcej instrukcji , zarejestruj się w usłudze AIForged i skonfiguruj projekt i usługę AIForged, wykonując kroki zdefiniowane w temacie Tworzenie projektu.

Oto praktyczny przykład sposobu wyodrębniania informacji z kart ubezpieczenia społecznego Przykład — zabezpieczenia społecznego.

Zapoznaj się również z naszym praktycznym przykładem wyodrębnienia informacji z aplikacji kredytowych Practical Example — aplikacja kredytowa.

Jak uzyskać poświadczenia

Do korzystania z usługi AIForged jest wymagane konto AIForged. Możesz zarejestrować się, instalując aplikację AIForged ze sklepu Microsoft Store lub witryny microsoft Store.

Po zainstalowaniu aplikacji możesz zarejestrować się przy użyciu prostych kroków rejestracji Rejestrowanie.

Aby aktywować konto, należy otrzymać wiadomość e-mail z linkiem aktywacji. Po kliknięciu linku aktywacji narzędzie AIForged zostanie otwarte z informacjami o aktywacji. Po aktywowaniu konta możesz zalogować się przy użyciu poświadczeń, a następnie użyć poświadczeń w łączniku.

Jak utworzyć i wytrenować usługę AIForged

Najpierw należy utworzyć kontener projektu na potrzeby rozliczeń. Po utworzeniu projektu możesz dodać inteligentną usługę, wykonując kroki kreatora w aplikacji AIForged.

Oto lista praktycznych przykładów wyodrębniania informacji z dokumentów

Przykład practicle — karty zabezpieczeń społecznych.

Praktyczny przykład — wyciągi bankowe.

Praktyczny przykład — aplikacja kredytowa.

Wprowadzenie do łącznika

Aby uzyskać więcej informacji na temat rozpoczynania pracy, zobacz następujący przewodnik po usłudze Power Automate — Wprowadzenie

Authentication

Ten łącznik używa OAuth2 uwierzytelniania (zobacz kroki opisane powyżej, jak go uzyskać). Podczas tworzenia nowego łącznika (w usłudze Power Apps/Logic Apps) należy podać informacje uwierzytelniania z rejestracji.

Znane problemy i ograniczenia

Nie można włączyć uwierzytelniania wieloskładnikowego/2FA dla poświadczeń używanych w łączniku.

Typowe błędy i środki zaradcze

Aby uzyskać pomoc lub pomoc techniczną, utwórz bilet pomocy technicznej w witrynie AIForged Support lub wyślij wiadomość e-mail na adres support@aiforged.com

Często zadawane pytania

Aby uzyskać więcej informacji i często zadawanych pytań, zobacz Dokumentację AIForged.

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Pobieranie bieżącego zalogowanego użytkownika

Pobieranie bieżącego zalogowanego użytkownika

Pobieranie bieżących danych i czasu usługi

Pobieranie bieżących danych i czasu usługi

Pobieranie definicji według identyfikatora

Pobieranie definicji według identyfikatora

Pobieranie dokumentu i powiązanych dokumentów

Pobieranie dokumentu i powiązanych dokumentów

Pobieranie dokumentu według identyfikatora

Pobieranie dokumentu według identyfikatora

Pobieranie hierarchii parametrów

Pobieranie hierarchii parametrów

Pobieranie hierarchii pól dla usługi

Pobieranie hierarchii pól dla usługi

Pobieranie hierarchii pól dla wszystkich usług w projekcie

Pobieranie hierarchii pól dla wszystkich usług w projekcie

Pobieranie klucza interfejsu API dla użytkownika

Pobieranie klucza interfejsu API dla użytkownika

Pobieranie najnowszej weryfikacji dla parametru

Pobieranie najnowszej weryfikacji dla parametru

Pobieranie obiektu blob danych dla identyfikatora dokumentu według typu obrazu

Pobieranie obiektu blob danych dla identyfikatora dokumentu według typu obrazu

Pobieranie obiektu blob według klucza obiektu blob

Pobieranie obiektu blob według klucza obiektu blob

Pobieranie obrazu weryfikacji rozdrobnionego

Pobieranie obrazu weryfikacji rozdrobnionego

Pobieranie obrazów dokumentów

Pobieranie obrazów dokumentów

Pobieranie obrazów dokumentów

Pobieranie obrazów dokumentów

Pobieranie określonego projektu

Pobieranie określonego projektu

Pobieranie parametru według identyfikatora weryfikacji

Pobieranie parametru według identyfikatora weryfikacji

Pobieranie podsumowania weryfikacji

Pobieranie podsumowania weryfikacji

Pobieranie podsumowania weryfikacji

Pobieranie podsumowania weryfikacji

Pobieranie projektów i usług połączonych z użytkownikiem

Pobieranie projektów i usług połączonych z użytkownikiem

Pobieranie typów danych

Pobieranie typów danych

Pobieranie usług związanych z projektem

Pobieranie usług związanych z projektem

Pobieranie usługi nadrzędnej dla parametru def według identyfikatora

Pobieranie usługi nadrzędnej dla parametru def według identyfikatora

Pobieranie usługi według identyfikatora

Pobieranie usługi według identyfikatora

Pobieranie wartości parametru

Pobieranie wartości parametru

Pobieranie wartości wyliczenia systemowego

Pobieranie wartości wyliczenia systemowego

Pobieranie według użytkownika i projektu

Pobieranie według użytkownika i projektu

Pobieranie weryfikacji dla parametru

Pobieranie weryfikacji dla parametru

Pobieranie wszystkich kategorii według projektu

Pobieranie wszystkich kategorii według projektu

Przekazywanie i klasyfikowanie dokumentu

Przekazywanie i klasyfikowanie dokumentu

Przekazywanie i wyodrębnianie informacji na potrzeby weryfikacji

Przekazywanie i wyodrębnianie informacji na potrzeby weryfikacji

Przekazywanie klasyfikacji dokumentów

Przekazywanie klasyfikacji dokumentów

Usuwanie dokumentu według identyfikatora

Usuwanie dokumentu według identyfikatora

Usuwanie obiektu blob dokumentu

Usuwanie obiektu blob dokumentu

Usuwanie parametru

Usuwanie parametru

Uzyskiwanie analizy weryfikacji

Uzyskiwanie analizy weryfikacji

Uzyskiwanie informacji o klasyfikacji

Uzyskiwanie informacji o klasyfikacji

Uzyskiwanie informacji o systemie i aplikacji

Uzyskiwanie informacji o systemie i aplikacji

Uzyskiwanie podglądu dokumentów i obrazów dla usługi

Uzyskiwanie podglądu dokumentów i obrazów dla usługi

Uzyskiwanie weryfikacji według identyfikatora

Uzyskiwanie weryfikacji według identyfikatora

Wyodrębnianie parametrów dokumentu

Wyodrębnianie parametrów dokumentu

Znajdowanie dokumentów przy użyciu kryteriów wyszukiwania ustrukturyzowanego. Wyniki można stronicować

Znajdowanie dokumentów przy użyciu kryteriów wyszukiwania ustrukturyzowanego. Wyniki można stronicować

Znajdowanie projektu według nazwy

Znajdowanie projektu według nazwy

Pobieranie bieżącego zalogowanego użytkownika

Pobieranie bieżącego zalogowanego użytkownika

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o użytkowniku

Pobieranie bieżących danych i czasu usługi

Pobieranie bieżących danych i czasu usługi

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

response
date-time

Pobieranie definicji według identyfikatora

Pobieranie definicji według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator definicji
id integer

Identyfikator definicji

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Service, settings abd rules definitions (Usługa, ustawienia definicji reguł abd)

Pobieranie dokumentu i powiązanych dokumentów

Pobieranie dokumentu i powiązanych dokumentów

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
id integer

Identyfikator dokumentu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o metadanych dokumentu

Pobieranie dokumentu według identyfikatora

Pobieranie dokumentu według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
id integer

Identyfikator dokumentu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o metadanych dokumentu

Pobieranie hierarchii parametrów

Pobieranie hierarchii parametrów

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
docId integer

Identyfikator dokumentu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Uwzględnij dane weryfikacji
includeverification boolean

Uwzględnij dane weryfikacji

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie hierarchii pól dla usługi

Pobieranie hierarchii pól dla usługi

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator projektu
projectId integer

Identyfikator projektu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Uwzględnij statystyki liczników
includeCount boolean

Uwzględnij statystyki liczników

Uwzględnij ustawienia
includeSettings boolean

Uwzględnij ustawienia

Uwzględnij definiitions podrzędne
includeChildren boolean

Uwzględnij definiitions podrzędne

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Service, settings abd rules definitions (Usługa, ustawienia definicji reguł abd)

Pobieranie hierarchii pól dla wszystkich usług w projekcie

Pobieranie hierarchii pól dla wszystkich usług w projekcie

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika

Identyfikator projektu
projectId integer

Identyfikator projektu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Identyfikator grupy
groupId integer

Identyfikator grupy

Uwzględnij statystyki liczników
includeCount boolean

Uwzględnij statystyki liczników

Uwzględnianie tylko usług
onlyServices boolean

Uwzględnianie tylko usług

Uwzględnij ustawienia
includeSettings boolean

Uwzględnij ustawienia

Uwzględnij elementy podrzędne
includeChildren boolean

Uwzględnij elementy podrzędne

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie klucza interfejsu API dla użytkownika

Pobieranie klucza interfejsu API dla użytkownika

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

response
string

Pobieranie najnowszej weryfikacji dla parametru

Pobieranie najnowszej weryfikacji dla parametru

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
docId integer

Identyfikator dokumentu

Identyfikator parametru
parameterId integer

Identyfikator parametru

Identyfikator definicji
pdId integer

Identyfikator definicji

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o weryfikacji systemu i użytkownika dla pól dotyczących dokumentów

Pobieranie obiektu blob danych dla identyfikatora dokumentu według typu obrazu

Pobieranie obiektu blob danych dla identyfikatora dokumentu według typu obrazu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika, który jest właścicielem dokumentu
userId string

Identyfikator użytkownika, który jest właścicielem dokumentu

Identyfikator obiektu blob
id integer

Identyfikator obiektu blob

Typ obiektu blob
type integer

Typ obiektu blob

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

response
file

Pobieranie obiektu blob według klucza obiektu blob

Pobieranie obiektu blob według klucza obiektu blob

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator obiektu blob
id integer

Identyfikator obiektu blob

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

response
file

Pobieranie obrazu weryfikacji rozdrobnionego

Pobieranie obrazu weryfikacji rozdrobnionego

Parametry

Nazwa Klucz Wymagane Typ Opis
Użytkownik rozdrabniacza
userId string

Użytkownik rozdrabniacza

Identyfikator dokumentu
docId integer

Identyfikator dokumentu

Identyfikator parametru
parId integer

Identyfikator parametru

Identyfikator weryfikacji
verificationId integer

Identyfikator weryfikacji

Jeśli obraz powinien być wbudowany
inline boolean

Jeśli obraz powinien być wbudowany

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

response
file

Pobieranie obrazów dokumentów

Pobieranie obrazów dokumentów

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
id integer

Identyfikator dokumentu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie obrazów dokumentów

Pobieranie obrazów dokumentów

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
id integer

Identyfikator dokumentu

Typ obrazu
type integer

Typ obrazu

Typ zawartości obrazu
contentType string

Typ zawartości obrazu

Filtr testowy
text string

Filtr testowy

Identyfikator powiązanego obiektu blob
blobid integer

Identyfikator powiązanego obiektu blob

Indeks strony
pageindex integer

Indeks strony

Liczba obrazów do zwrócenia
imagesCount integer

Liczba obrazów do zwrócenia

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie określonego projektu

Pobieranie określonego projektu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika

Identyfikator projektu
projectId integer

Identyfikator projektu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Projekty to kontener do rozliczeń i usług

Pobieranie parametru według identyfikatora weryfikacji

Pobieranie parametru według identyfikatora weryfikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator weryfikacji
verificationId integer

Identyfikator weryfikacji

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Wartości pól połączone z dokumentami

Pobieranie podsumowania weryfikacji

Pobieranie podsumowania weryfikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator projektu
projectId integer

Identyfikator projektu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie podsumowania weryfikacji

Pobieranie podsumowania weryfikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator projektu
projectId integer

Identyfikator projektu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Identyfikator definicji
pdId integer

Identyfikator definicji

Tylko najnowsza wersja lub historia
latestOnly boolean

Tylko najnowsza wersja lub historia

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie projektów i usług połączonych z użytkownikiem

Pobieranie projektów i usług połączonych z użytkownikiem

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie typów danych

Pobieranie typów danych

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie usług związanych z projektem

Pobieranie usług związanych z projektem

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika

Identyfikator projektu
projectId integer

Identyfikator projektu

Filtr typu usługi
stlfilter integer

Filtr typu usługi

Filtruj według aparatu
enginefilter string

Filtruj według aparatu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie usługi nadrzędnej dla parametru def według identyfikatora

Pobieranie usługi nadrzędnej dla parametru def według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator definicji parametru
id integer

Identyfikator definicji parametru

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Service, settings abd rules definitions (Usługa, ustawienia definicji reguł abd)

Pobieranie usługi według identyfikatora

Pobieranie usługi według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator usługi
stpdId integer

Identyfikator usługi

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Service, settings abd rules definitions (Usługa, ustawienia definicji reguł abd)

Pobieranie wartości parametru

Pobieranie wartości parametru

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
docId integer

Identyfikator dokumentu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Kategoria parametrów
category integer

Kategoria parametrów

Grupowanie parametrów
grouping integer

Grupowanie parametrów

Uwzględnij dane weryfikacji
includeverification boolean

Uwzględnij dane weryfikacji

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie wartości wyliczenia systemowego

Pobieranie wartości wyliczenia systemowego

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie według użytkownika i projektu

Pobieranie według użytkownika i projektu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika

Identyfikator projektu
projectId integer

Identyfikator projektu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie weryfikacji dla parametru

Pobieranie weryfikacji dla parametru

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
docId integer

Identyfikator dokumentu

Identyfikator parametru
parameterId integer

Identyfikator parametru

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Pobieranie wszystkich kategorii według projektu

Pobieranie wszystkich kategorii według projektu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator ptoject
projectId integer

Identyfikator ptoject

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Przekazywanie i klasyfikowanie dokumentu

Przekazywanie i klasyfikowanie dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator usługi
stpdId integer

Identyfikator usługi

Identyfikator projektu
projectId integer

Identyfikator projektu

Dane pliku
file file

Dane pliku

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o metadanych dokumentu

Przekazywanie i wyodrębnianie informacji na potrzeby weryfikacji

Przekazywanie i wyodrębnianie informacji na potrzeby weryfikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator usługi
stpdId integer

Identyfikator usługi

Identyfikator projektu
projectId integer

Identyfikator projektu

Plik
file file

Plik

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o metadanych dokumentu

Przekazywanie klasyfikacji dokumentów

Przekazywanie klasyfikacji dokumentów

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator usługi
stpdId integer

Identyfikator usługi

Identyfikator projektu
projectId integer

Identyfikator projektu

Identyfikator dokumentu
docId integer

Identyfikator dokumentu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Kategorie/klasy do trenowania i klasyfikacji

Usuwanie dokumentu według identyfikatora

Usuwanie dokumentu według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu do usunięcia
id integer

Identyfikator dokumentu do usunięcia

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o metadanych dokumentu

Usuwanie obiektu blob dokumentu

Usuwanie obiektu blob dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator obiektu blob
id integer

Identyfikator obiektu blob

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

response
file

Usuwanie parametru

Usuwanie parametru

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator parametru
paramid integer

Identyfikator parametru

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Wartości pól połączone z dokumentami

Uzyskiwanie analizy weryfikacji

Uzyskiwanie analizy weryfikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator projektu
projectId integer

Identyfikator projektu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Tylko najnowsze
latestOnly boolean

Tylko najnowsze

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Uzyskiwanie informacji o klasyfikacji

Uzyskiwanie informacji o klasyfikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator klasyfikacji
Id integer

Identyfikator klasyfikacji

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Kategorie/klasy do trenowania i klasyfikacji

Uzyskiwanie informacji o systemie i aplikacji

Uzyskiwanie informacji o systemie i aplikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

response
object

Uzyskiwanie podglądu dokumentów i obrazów dla usługi

Uzyskiwanie podglądu dokumentów i obrazów dla usługi

Parametry

Nazwa Klucz Wymagane Typ Opis
Użytkownik, który jest właścicielem usługi
userId string

Użytkownik, który jest właścicielem usługi

Identyfikator projektu
projectId integer

Identyfikator projektu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Uzyskiwanie weryfikacji według identyfikatora

Uzyskiwanie weryfikacji według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator weryfikacji
verificationId integer

Identyfikator weryfikacji

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Informacje o weryfikacji systemu i użytkownika dla pól dotyczących dokumentów

Wyodrębnianie parametrów dokumentu

Wyodrębnianie parametrów dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
docid integer

Identyfikator dokumentu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Znajdowanie dokumentów przy użyciu kryteriów wyszukiwania ustrukturyzowanego. Wyniki można stronicować

Znajdowanie dokumentów przy użyciu kryteriów wyszukiwania ustrukturyzowanego. Wyniki można stronicować

Parametry

Nazwa Klucz Wymagane Typ Opis
Właściciel dokumentu
userId string

Właściciel dokumentu

Identyfikator projektu
projectId integer

Identyfikator projektu

Identyfikator usługi
stpdId integer

Identyfikator usługi

Folder lub użycie
usage integer

Folder lub użycie

Stan
status integer

Stan

Filtr nazwy klasy
classname string

Filtr nazwy klasy

Filtr nazwy pliku
filename string

Filtr nazwy pliku

Filtr typu pliku
filetype string

Filtr typu pliku

Zakres dat rozpoczęcia dla dokumentów
start date-time

Zakres dat rozpoczęcia dla dokumentów

Zakres dat zakończenia dla dokumentów
end date-time

Zakres dat zakończenia dla dokumentów

Wzorzec lub element nadrzędny dokumentu
masterid integer

Wzorzec lub element nadrzędny dokumentu

Numer strony
pageNo integer

Numer strony

Rozmiar strony
pageSize integer

Rozmiar strony

Sortuj według pola
sortField integer

Sortuj według pola

Kierunek sortowania na podstawie pola sortowania
sortDirection integer

Kierunek sortowania na podstawie pola sortowania

Filtruj pod kątem komentarzy
comment string

Filtruj pod kątem komentarzy

Filtrowanie wyników
result string

Filtrowanie wyników

Filtrowanie identyfikatora wyniku
resultId string

Filtrowanie identyfikatora wyniku

Filtruj pod kątem indeksu wyników
resultIndex integer

Filtruj pod kątem indeksu wyników

Filtruj pod kątem identyfikatorów zewnętrznych
externalId string

Filtruj pod kątem identyfikatorów zewnętrznych

Filtruj pod kątem identyfikatorów GUID dokumentu
docGuid string

Filtruj pod kątem identyfikatorów GUID dokumentu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Znajdowanie projektu według nazwy

Znajdowanie projektu według nazwy

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika

Nazwa projektu
projectName string

Nazwa projektu

Nagłówek wersji interfejsu API
X-Api-Version True string

Nagłówek wersji interfejsu API

Zwraca

Projekty to kontener do rozliczeń i usług

Definicje

AIForged.ViewModels.UserViewModel

Informacje o użytkowniku

Nazwa Ścieżka Typ Opis
id
id string
userName
userName string
fullName
fullName string
e-mail
email email
tytuł stanowiska
jobTitle string
numer telefonu
phoneNumber phone
konfiguracja
configuration string
jest włączony
isEnabled boolean
isLockedOut
isLockedOut boolean
friendlyName
friendlyName string
utworzone przez
createdBy string
zaktualizowanoPrzez
updatedBy string
data utworzenia
createdDate date-time
zaktualizowana data
updatedDate date-time
roles
roles array of string

AIForged.ViewModels.ClassesViewModel

Kategorie/klasy do trenowania i klasyfikacji

Nazwa Ścieżka Typ Opis
id
id integer
userId
userId string
identyfikator projektu
projectId integer
nazwa
name string
opis
description string
komentarz
comment string
dtc
dtc date-time
dtm
dtm date-time
typ
type AIForged.DAL.ClassType

Typ kategorii systemowej

Powiązane
related integer

AIForged.DAL.ClassType

Typ kategorii systemowej

Typ kategorii systemowej

AIForged.ViewModels.DocumentViewModel

Informacje o metadanych dokumentu

Nazwa Ścieżka Typ Opis
id
id integer
userId
userId string
identyfikator projektu
projectId integer
serviceId (identyfikator usługi)
serviceId integer
stan
status AIForged.DAL.DocumentStatus

Wskazuje stan dokumentu w systemie

użycie
usage AIForged.DAL.UsageType

Dlaczego przechowujemy ten dokument

classId
classId integer
typ treści
contentType string
filename
filename string
fileType
fileType string
dtc
dtc date-time
dtm
dtm date-time
documentId
documentId guid
Identyfikator zewnętrzny
externalId string
identyfikator masterId
masterId integer
wynik
result string
resultId
resultId string
resultIndex
resultIndex integer
komentarz
comment string
availability
availability AIForged.DAL.Availability

Możliwość oceny rekordu

resultParameters
resultParameters array of AIForged.ViewModels.DocumentParameterViewModel
dane
data array of AIForged.ViewModels.DocumentDataViewModel
Dokumentów
documents array of AIForged.ViewModels.DocumentViewModel
originId (identyfikator początkowy)
originId integer
canVerify
canVerify boolean
canClassify
canClassify boolean
canTrain
canTrain boolean
Przeszkoleni
trained boolean
linkedDocsCount
linkedDocsCount integer
trainingFieldCount
trainingFieldCount integer
trainedParametersCount
trainedParametersCount integer

AIForged.DAL.DocumentStatus

Wskazuje stan dokumentu w systemie

Wskazuje stan dokumentu w systemie

AIForged.DAL.UsageType

Dlaczego przechowujemy ten dokument

Dlaczego przechowujemy ten dokument

AIForged.DAL.Availability

Możliwość oceny rekordu

Możliwość oceny rekordu

AIForged.ViewModels.DocumentParameterViewModel

Wartości pól połączone z dokumentami

Nazwa Ścieżka Typ Opis
id
id integer
documentId
documentId integer
paramDefId
paramDefId integer
parentId (identyfikator rodzica)
parentId integer
sourceId
sourceId integer
value
value string
dane
data byte
indeks
index integer
colIndex
colIndex integer
colSpan (rozpiętość)
colSpan integer
rowIndex
rowIndex integer
rowSpan (rozpiętość)
rowSpan integer
availability
availability AIForged.DAL.Availability

Możliwość oceny rekordu

paramDef
paramDef

Service, settings abd rules definitions (Usługa, ustawienia definicji reguł abd)

Dzieci
children array of AIForged.ViewModels.DocumentParameterViewModel
Weryfikacje
verifications array of AIForged.ViewModels.VerificationViewModel

AIForged.ViewModels.ParameterDefViewModel

Service, settings abd rules definitions (Usługa, ustawienia definicji reguł abd)

Nazwa Ścieżka Typ Opis
id
id integer
identyfikator projektu
projectId integer
serviceTypeId
serviceTypeId integer
serviceId (identyfikator usługi)
serviceId integer
classId
classId integer
parentId (identyfikator rodzica)
parentId integer
nazwa
name string
etykieta
label string
tags
tags string
opis
description string
dtc
dtc date-time
dtm
dtm date-time
stan
status AIForged.DAL.ParameterDefinitionStatus

Stan definicji

kategoria
category AIForged.DAL.ParameterDefinitionCategory

Kategoria definicji

grupowanie
grouping AIForged.DAL.GroupingType

Typ grupowania pól

valueType
valueType AIForged.DAL.ValueType

Typ wartości używanych dla reguł i ustawień

valueTypeName
valueTypeName string
defaultValue (wartość domyślna)
defaultValue string
required
required AIForged.DAL.RequiredOption

Wskazuje, czy wymagana jest opcja

indeks
index integer
info
info string
odwołanie
reference string
klasyfikacja
rating float
availability
availability AIForged.DAL.Availability

Możliwość oceny rekordu

Dzieci
children array of AIForged.ViewModels.ParameterDefViewModel
ustawienia
settings array of AIForged.DAL.Models.ParameterDefSettingViewModel
totalCharge
totalCharge double
liczba użytkowników
userCount integer
parametrCount
parameterCount integer
documentCount
documentCount integer
sprawdzanie poprawności
validation string

AIForged.DAL.ParameterDefinitionStatus

Stan definicji

Stan definicji

AIForged.DAL.ParameterDefinitionCategory

Kategoria definicji

Kategoria definicji

AIForged.DAL.GroupingType

Typ grupowania pól

Typ grupowania pól

AIForged.DAL.ValueType

Typ wartości używanych dla reguł i ustawień

Typ wartości używanych dla reguł i ustawień

AIForged.DAL.RequiredOption

Wskazuje, czy wymagana jest opcja

Wskazuje, czy wymagana jest opcja

AIForged.DAL.Models.ParameterDefSettingViewModel

Szczegółowe ustawienia reguł i ustawień

Nazwa Ścieżka Typ Opis
id
id integer
parametrDefId
parameterDefId integer
typ
type AIForged.DAL.SettingType

Typ ustawienia powiązanego z parametrem

stan
status AIForged.DAL.SettingStatus

Stan ustawienia powiązanego z parametrem

dtc
dtc date-time
dtm
dtm date-time
komentarz
comment string
info
info string
dane
data string
minValue (wartość minimalna)
minValue string
maxValue (maksymalna wartość)
maxValue string
pewność
confidence float
minConfidence
minConfidence float
maxConfidence
maxConfidence float
isCaseSensative
isCaseSensative boolean
Odwróć
invert boolean
oneLine
oneLine boolean
oneWord
oneWord boolean
isHandwriting
isHandwriting boolean
orientacja
orientation AIForged.DAL.Orientation

Orientacja tekstu pola

Oznaczanie
marking AIForged.DAL.MarkingType

Znakowanie typu tekstu

Komórek
cells integer
clearBefore
clearBefore AIForged.DAL.OptionStatusFlags

Flaga stanu opcji

clearAfter
clearAfter AIForged.DAL.OptionStatusFlags

Flaga stanu opcji

cleanupValuesBefore
cleanupValuesBefore boolean
cleanupValuesAfter
cleanupValuesAfter boolean
validateValuesBefore
validateValuesBefore boolean
validateValuesAfter
validateValuesAfter boolean
abortOnValidationError
abortOnValidationError boolean
isReplacementCaseSensative
isReplacementCaseSensative boolean
compileResults
compileResults string
maxRetry
maxRetry integer
przerwa czasowa
timeout string
userId
userId string

AIForged.DAL.SettingType

Typ ustawienia powiązanego z parametrem

Typ ustawienia powiązanego z parametrem

AIForged.DAL.SettingStatus

Stan ustawienia powiązanego z parametrem

Stan ustawienia powiązanego z parametrem

AIForged.DAL.Orientation

Orientacja tekstu pola

Orientacja tekstu pola

AIForged.DAL.MarkingType

Znakowanie typu tekstu

Znakowanie typu tekstu

AIForged.DAL.OptionStatusFlags

Flaga stanu opcji

Flaga stanu opcji

AIForged.ViewModels.VerificationViewModel

Informacje o weryfikacji systemu i użytkownika dla pól dotyczących dokumentów

Nazwa Ścieżka Typ Opis
id
id integer
parameterId
parameterId integer
userId
userId string
value
value string
Dt
dt date-time
pewność
confidence float
symboleKonfidencja
symbolsConfidence string
typ
type AIForged.DAL.VerificationType

Typ weryfikacji

stan
status AIForged.DAL.VerificationStatus

Flagi stanu weryfikacji

wynik
result string
pudełko
box string
info
info string
dane
data byte
userName
userName string
serviceId (identyfikator usługi)
serviceId integer
serviceDocId
serviceDocId integer
dostawca
provider string
settingId
settingId integer
workItem
workItem integer
transactionId (identyfikator transakcji)
transactionId integer
opłata
charge double

AIForged.DAL.VerificationType

Typ weryfikacji

Typ weryfikacji

AIForged.DAL.VerificationStatus

Flagi stanu weryfikacji

Flagi stanu weryfikacji

AIForged.ViewModels.DocumentDataViewModel

Dokumentowanie danych obiektu blob

Nazwa Ścieżka Typ Opis
id
id integer
documentId
documentId integer
blobId
blobId integer
typ
type AIForged.DAL.DocumentDataType

Wskazuje typ danych związanych z dokumentem

dane
data byte
wersja zapoznawcza
preview byte
SMS
text string
info
info string
typ treści
contentType string
resultId
resultId string
indeks
index integer
width
width double
height
height double
rozdzielczość
resolution double
availability
availability AIForged.DAL.Availability

Możliwość oceny rekordu

AIForged.DAL.DocumentDataType

Wskazuje typ danych związanych z dokumentem

Wskazuje typ danych związanych z dokumentem

AIForged.ViewModels.DocParamSummary

Podsumowanie dokumentu dla statystyk z informacjami o parametrach

Nazwa Ścieżka Typ Opis
identyfikator projektu
projectId integer
typ usługi
serviceType integer
serviceId (identyfikator usługi)
serviceId integer
użycie
usage AIForged.DAL.UsageType

Dlaczego przechowujemy ten dokument

stan
status AIForged.DAL.DocumentStatus

Wskazuje stan dokumentu w systemie

nazwa
name string
classId
classId integer
className
className string
serviceName
serviceName string
fileType
fileType string
Dt
dt date-time
count
count integer
etykietaCount
labelledCount integer
identyfikator pdId
pdId integer
paramDefName
paramDefName string
kategoria
category AIForged.DAL.ParameterDefinitionCategory

Kategoria definicji

grupowanie
grouping AIForged.DAL.GroupingType

Typ grupowania pól

valueType
valueType AIForged.DAL.ValueType

Typ wartości używanych dla reguł i ustawień

value
value string
indeks
index integer

AIForged.ViewModels.DocumentExtraction

Transponowane wyodrębnianie wyników dokumentu ustrukturyzowanego

Nazwa Ścieżka Typ Opis
id
id integer
parentId (identyfikator rodzica)
parentId integer
nazwa
name string
etykieta
label string
kategoria
category AIForged.DAL.ParameterDefinitionCategory

Kategoria definicji

grupowanie
grouping AIForged.DAL.GroupingType

Typ grupowania pól

valueType
valueType AIForged.DAL.ValueType

Typ wartości używanych dla reguł i ustawień

indeks
index integer
parametrmId
paramId integer
parentParamId
parentParamId integer
paramIndex
paramIndex integer
paramValue
paramValue string
verificationId
verificationId integer
userId
userId string
userName
userName string
value
value string
Dt
dt date-time
pewność
confidence float
typ
type AIForged.DAL.VerificationType

Typ weryfikacji

stan
status AIForged.DAL.VerificationStatus

Flagi stanu weryfikacji

opłata
charge double
dostawca
provider string
wynik
result string

AIForged.ViewModels.ProjectViewModel

Projekty to kontener do rozliczeń i usług

Nazwa Ścieżka Typ Opis
id
id integer
userId
userId string
stan
status AIForged.DAL.ProjectStatus

Służy do wskazywania stanu projektu

nazwa
name string
opis
description string
komentarz
comment string
dtc
dtc date-time
dtm
dtm date-time
saldo
balance

Informacje księgowe dotyczące projektów i usług

totalDocsCount
totalDocsCount integer
services
services array of AIForged.ViewModels.ParameterDefViewModel

AIForged.DAL.ProjectStatus

Służy do wskazywania stanu projektu

Służy do wskazywania stanu projektu

AIForged.ViewModels.DataTypeViewModel

Typy danych używane do reguł i przetwarzania wewnętrznego

Nazwa Ścieżka Typ Opis
id
id AIForged.DAL.ValueType

Typ wartości używanych dla reguł i ustawień

nazwa
name string
opis
description string
kategoria
category AIForged.DAL.DataTypeCategory

Kategoria typów danych

valueTypeName
valueTypeName string
defaultValue (wartość domyślna)
defaultValue string
dane
data string

AIForged.DAL.DataTypeCategory

Kategoria typów danych

Kategoria typów danych

AIForged.ViewModels.EnumDataViewModel

Lista wyliczenie systemu i podstawowe informacje o interfejsie użytkownika

Nazwa Ścieżka Typ Opis
id
id integer
typ
type AIForged.DAL.EnumType

Wyliczenie wszystkich wyliczenia w systemie

typeName (nazwa_typu)
typeName string
nazwa
name string
value
value integer
opis
description string
info
info string
icon
icon string
color
color string

AIForged.DAL.EnumType

Wyliczenie wszystkich wyliczenia w systemie

Wyliczenie wszystkich wyliczenia w systemie

AIForged.ViewModels.VerificationSummary

Informacje o weryfikacji systemu i użytkownika dla pól dotyczących dokumentów

Nazwa Ścieżka Typ Opis
id
id integer
parameterId
parameterId integer
userId
userId string
value
value string
Dt
dt date-time
pewność
confidence float
symboleKonfidencja
symbolsConfidence string
typ
type AIForged.DAL.VerificationType

Typ weryfikacji

stan
status AIForged.DAL.VerificationStatus

Flagi stanu weryfikacji

wynik
result string
pudełko
box string
info
info string
dane
data byte
userName
userName string
serviceId (identyfikator usługi)
serviceId integer
serviceDocId
serviceDocId integer
dostawca
provider string
settingId
settingId integer
workItem
workItem integer
transactionId (identyfikator transakcji)
transactionId integer
opłata
charge double
paramDefId
paramDefId integer
paramDefName
paramDefName string
identyfikator projektu
projectId integer
nazwa projektu
projectName string
docId
docId integer
docFileName
docFileName string
docContentType
docContentType string
docUsage
docUsage AIForged.DAL.UsageType

Dlaczego przechowujemy ten dokument

docStatus
docStatus AIForged.DAL.DocumentStatus

Wskazuje stan dokumentu w systemie

classId
classId integer
className
className string
rok
year integer
miesiąca
month integer
day
day integer
dayOfWeek
dayOfWeek System.DayOfWeek

Dzień kalendarzowy tygodnia

count
count integer
średnia
average float
min
min float
max
max float

System.DayOfWeek

Dzień kalendarzowy tygodnia

Dzień kalendarzowy tygodnia

plik

Jest to podstawowy typ danych "file".

ciąg

Jest to podstawowy typ danych "string".

obiekt

Jest to typ 'obiekt'.

date-time