AmoditSendAttachmentToOCREx()

Funkcja AmoditSendAttachmentToOCREx() wysyła dokument z określonego pola załącznika do systemu AMODIT AI OCR w celu przetworzenia. Przyjmuje obiekt opcji, który pozwala na określenie nazwy załącznika, nazwy modelu OCR, opcjonalnej reguły wywołania zwrotnego do wykonania po zakończeniu oraz opcjonalnej flagi wymuszającej wysłanie, nawet jeśli dokument został już wcześniej wysłany. Możliwe jest również ograniczenie ilości stron przesyłanych z danego dokumentu do OCR.

Składnia

AmoditSendAttachmentToOCREx(options);

Argumenty funkcji

options - (Object) obiekt zawierający konfigurację dla żądania OCR. Poniżej wymieniono wszystkie możliwe właściwości.
options.attachmentName - (String) nazwa pola typu dokument, z którego zawartość załączonego pliku zostanie wysłana do systemu OCR.
options.model - (String) [Optional] nazwa modelu OCR do użycia (np. ‘amodit-invoice’).
options.ruleAfterFill - (String) [Optional] nazwa reguły do wykonania, gdy system OCR wyśle wywołanie zwrotne z odczytaną zawartością dokumentu.
options.forceSend - (Boolean) [Optional] jeśli true, dokument zostanie wysłany, nawet jeśli został już wcześniej wysłany.
options.additionalFields - (String) [Optional] zawiera listę dodatkowych pól oddzielonych przecinkami. W nawiasie po spacji przy każdym polu można podać dodatkowy opis/polecenie dla AI.
options.pdfFirstPages - (Decimal) [Optional] liczba pierwszych stron do wyodrębnienia z PDF przed wysłaniem do OCR. Domyślna wartość: 10. Jeśli ustawione na 0, żadne strony nie będą wyodrębnione z początku.
options.pdfLastPages - (Decimal) [Optional] liczba ostatnich stron do wyodrębnienia z PDF przed wysłaniem do OCR. Domyślna wartość: 3. Jeśli ustawione na 0, żadne strony nie będą wyodrębnione z końca.

Wartość zwracana

Funkcja zwraca String. Funkcja AmoditSendAttachmentToOCREx() zwraca identyfikator dokumentu zarejestrowanego w systemie AI OCR. Zwrócenie przez funkcję pustego ciągu znaków może oznaczać problemy w komunikacji z systemem AI OCR, a wtedy może być wymagane ponowne wysłanie dokumentu (warto użyć opcji options.forceSend ustawionej na true).

Przykłady

Przykład 1 - podstawowe wywołanie

Funkcja wysyła dokument z pola o nazwie “invoice” do systemu AI OCR, używając modelu o identyfikatorze “amodit-invoice”.

options.attachmentName = "invoice";
options.model = "amodit-invoice";
AmoditSendAttachmentToOCREx(options);

Przykład 2 - użycie reguły po zwróceniu wyniku z AI OCR

Funkcja wysyła dokument z pola o nazwie “invoice” do systemu AI OCR, używając modelu o identyfikatorze “amodit-invoice”. Dodatkowo została określona reguła procesu o nazwie “ProcessInvoiceData”, która zostanie wykonana po przeprocesowaniu dokumentu przez AI OCR.

options.attachmentName = "invoice";
options.model = "amodit-invoice";
options.ruleAfterFill = "ProcessInvoiceData";
AmoditSendAttachmentToOCREx(options);

Przykład 3 - wymuszenie ponownej wysyłki dokumentu do AI OCR

Funkcja wymusza wysłanie dokumentu z pola o nazwie “invoice” do systemu AI OCR, używając modelu o identyfikatorze “amodit-invoice” pomimo tego, że był on już wcześniej wysłany.

options.attachmentName = "invoice";
options.model = "amodit-invoice";
options.forceSend = true;
AmoditSendAttachmentToOCREx(options);

Przykład 4 - ekstrakcja dodatkowych danych

Funkcja wymusza wysłanie dokumentu z pola o nazwie “invoice” do systemu AI OCR z wykorzystanie modelu o identyfikatorze “amodit-invoice” (domyślny model do rozpoznawnia zawartości faktur). Dodatkowo określono pola do ekstrakcji spoza standardowego zbioru atrybutów faktury. W nawiasach podano, jakie etykiety na dokumencie faktury posiadają te dodatkowe atrybuty do ekstrakcji.

options.attachmentName = "invoice";
options.model = "amodit-invoice";
options.forceSend = true;
options.additionalFields = "telefonKontaktowy (Numer telefonu kontaktowego), emailKontaktowy (Adres email kontaktowy)";
AmoditSendAttachmentToOCREx(options);

Przykład 5 - wydzielanie stron dokumentu przesyłanych do AI OCR

Funkcja wysyła dokument PDF do systemu AI OCR, wyodrębniając tylko pierwsze 2 strony i ostatnią 1 stronę. Strony nie są duplikowane. Jeśli dokument nie jest PDF, zostanie wysłany bez modyfikacji.

options.attachmentName = "invoice";
options.model = "amodit-invoice";
options.pdfFirstPages = 2;
options.pdfLastPages = 1;
AmoditSendAttachmentToOCREx(options);