Udostępnij przez

Zuva DocAI

Osadzanie sztucznej inteligencji kontraktów w przepływach pracy produktu przy użyciu rozwiązania Zuva DocAI. Nie ma potrzeby opracowywania sztucznej inteligencji od podstaw, korzystaj z interfejsów API docAI, aby wyodrębnić informacje z kontraktów.

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 Obsługa rozwiązania Zuva
adres URL https://zuva.ai/support/
Email support@zuva.ai
Metadane łącznika
Publisher Zuva Inc.
Witryna internetowa https://zuva.ai/
Zasady ochrony prywatności https://zuva.ai/privacy/
Kategorie AI

Ten łącznik umożliwia użytkownikom znajdowanie i wyodrębnianie jednostek, zdań i akapitów z kontraktów (i powiązanych dokumentów) przy użyciu najlepszej w klasie AI kontraktów Zuva. Zaprojektowany i wytrenowany w celu zidentyfikowania klauzul prawnych w wielu branżach i przypadkach użycia ten łącznik udostępnia zestaw modułów plug-and-play do osadzania sztucznej inteligencji kontraktów w przepływach pracy. Ten łącznik zawiera funkcję OCR do odczytywania dokumentów, a także możliwości klasyfikacji i normalizacji dokumentów.

Wymagania wstępne

Będziesz potrzebować konta Zuva i tokenu docAI. Rozpocznij od zarejestrowania się w celu uzyskania bezpłatnego konta.

Jak uzyskać poświadczenia

Zuva DocAI ma wiele serwerów regionalnych. Należy utworzyć token interfejsu API dla określonego regionu, którego chcesz użyć.

  1. Utwórz konto i/lub zaloguj się na zuva.ai.
  2. Przejdź do konsoli DocAI
  3. Wybierz region, którego chcesz użyć.
  4. Skopiuj podstawowy adres URL regionu do połączenia.
  5. Utwórz token i skopiuj go do użycia w połączeniu.

Aby uzyskać więcej informacji na temat kont i tokenów usługi Zuva, zobacz przewodnik Szybki start dotyczący usługi DocAI .

Wprowadzenie do łącznika

Aby użyć łącznika Zuva DocAI, należy ustawić przepływ podobny do następującego:

Krok 1. Uzyskiwanie pliku

Do celów testowych można utworzyć "Błyskawiczny przepływ w chmurze" w usłudze Power Automate. Wybierz pozycję "Ręcznie wyzwól przepływ" i utwórz przepływ. Dodaj dane wejściowe i wybierz typ "Plik".

Krok 2. Przesyłanie pliku

Submit a file Dodaj akcję i wybierz pozycję "Zawartość pliku" z poprzedniego kroku jako dane wejściowe.

Uwaga: plik nie powinien być przekształcany w żaden sposób (tj. bez kodowania base64). DocAI akceptuje tylko nieprzetworzone dane binarne.

Krok 3. Rozpoczęcie przetwarzania pliku

Wybierz usługę, której chcesz użyć, dodając jedną z następujących akcji:

  • Create Language Classification Request
  • Create Document Classification Request
  • Create Multi-Level Classification Request
  • Create Field Extraction Request
  • Create OCR Request

Każdy z nich akceptuje identyfikator pliku (zwrócony z Submit a file akcji) jako dane wejściowe.

Wyodrębnianie pól dodatkowo wymaga identyfikatorów pól jako danych wejściowych. Identyfikatory pól można znaleźć w bibliotece pól (wymagane logowanie), od trenera sztucznej inteligencji, jeśli wytrenowane pola niestandardowe lub programowo przy użyciu Get Field List akcji.

Krok 4. Sonduj pod kątem ukończenia żądania

Użyj bloku (znajdującego Do Until się w sekcji "Kontrolka") i dodaj prawidłową akcję sprawdzania stanu do wewnątrz bloku:

  • Get Field Extraction Request Status
  • Get Language Classification Request Status
  • Get Document Classification Request Status
  • Get MLC request Status
  • Get OCR Request Status

Akcja jest wykonywana Get ____ status jako dane wejściowe identyfikatora żądania z odpowiedniej Create ____ Request akcji.

Należy również dodać 10-sekundowy Delay blok wewnątrz Do until bloku, aby upewnić się, że plik ma wystarczający czas do przetworzenia.

Ustaw warunek dla Do Until bloku na Is Finished? wartość jest równy true.

Krok 4. Pobieranie wyników

Na koniec użyj jednej z akcji Pobierz wyniki odpowiadającej twojemu żądaniu, używając identyfikatora żądania z oryginalnej operacji Utwórz jako danych wejściowych:

  • Get Field Extraction Request Text Results
  • Get Language Classification Request Status
  • Get Document Classification Request Status
  • Get MLC request Status
  • Get OCR Results Text
  • Get OCR Results Images

Należy pamiętać, że w przypadku języka, klasyfikacji dokumentów i uczenia maszynowego wyniki są uwzględniane w odpowiedzi Stan.

Aby uzyskać więcej informacji na temat struktury wyników wyodrębniania pól, możesz zapoznać się z dokumentacją witryny DocAI .

Znane problemy i ograniczenia

Pola na żądanie

W jednej Create Field Extraction Request akcji można uwzględnić maksymalnie 100 pól.

Pola niestandardowe

Łącznik nie obsługuje żadnych punktów końcowych witryny DocAI związanych z trenowaniem pól niestandardowych ani pobierania metadanych poszczególnych pól.

Różnice w podstawowym interfejsie API

Ponadto należy pamiętać, że funkcje łącznika nie odpowiadają jednemu z dokumentacją podstawowego interfejsu API. W szczególności łącznik:

  1. Uwidacznia dodatkową is_finished wartość logiczną, która może służyć do określania, czy żądanie zostało ukończone, czy zakończone niepowodzeniem
  2. Wszystkie żądania działają na pojedynczych plikach, a nie na partiach wielu plików.

Typowe błędy i środki zaradcze

Pamiętaj, aby przekazać nieprzetworzone pliki binarne, a nie ciągi zakodowane w formacie base64. Możesz użyć usługi OCR i sprawdzić, czy zwraca oczekiwany tekst.

Często zadawane pytania

Gdzie można znaleźć dodatkowe informacje o usłudze Zuva DocAI?

https://zuva.ai/docai/

Gdzie można znaleźć dodatkową dokumentację dotyczącą rozwiązania Zuva DocAI?

https://zuva.ai/documentation/

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Żeton securestring Token witryny DocAI Prawda
Podstawowy adres URL ciąg Na przykład: https://us.app.zuva.ai/api/v2 Prawda

Limity ograniczania

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

Akcje

Normalizowanie dat

Normalizuj ciąg zawierający co najmniej jedną datę. Dla każdej znalezionej daty punkt końcowy zwraca zestaw liczb całkowitych reprezentujących rok, miesiąc i dzień.
Pobieranie listy pól

Pobierz listę wszystkich dostępnych pól.
Pobieranie obrazów żądań OCR

Pobierz obrazy z ukończonego żądania OCR.
Pobieranie stanu żądania klasyfikacji dokumentów

Pobierz stan i dostępne wyniki dla istniejącego żądania klasyfikacji dokumentów.
Pobieranie stanu żądania wyodrębniania pól

Sprawdź stan istniejącego żądania wyodrębniania pól.
Pobieranie wyników żądania wyodrębniania pól

Pobierz wyniki tekstowe z ukończonego żądania wyodrębniania pól.
Przesyłanie pliku

Prześlij plik do usługi Zuva DocAI.
Tworzenie żądania klasyfikacji dokumentów

Utwórz żądanie klasyfikacji określonego dokumentu.
Tworzenie żądania klasyfikacji języka

Utwórz żądanie dla języka określonego pliku.
Tworzenie żądania klasyfikacji na poziomie wielu poziomów

Utwórz żądanie klasyfikacji wieloeziomowej określonego pliku.
Tworzenie żądania OCR

Utwórz nowe żądanie OCR, które ma zostać zastosowane do określonego pliku.
Tworzenie żądania wyodrębniania pól

Utwórz nowe żądanie wyodrębniania z określonego pliku.
Usuwanie pliku

Usuń istniejący plik z Zuva.
Uzyskiwanie stanu żądania klasyfikacji języka

Pobierz stan i dostępne wyniki dla istniejącego żądania klasyfikacji dokumentów.
Uzyskiwanie stanu żądania MLC

Pobierz stan i dostępne wyniki dla istniejącego żądania MLC.
Uzyskiwanie stanu żądania OCR

Sprawdź stan istniejącego żądania OCR.
Uzyskiwanie tekstu żądania OCR

Pobierz tekst z ukończonego żądania OCR.

Normalizowanie dat

Identyfikator operacji:
NormalizeDates

Normalizuj ciąg zawierający co najmniej jedną datę. Dla każdej znalezionej daty punkt końcowy zwraca zestaw liczb całkowitych reprezentujących rok, miesiąc i dzień.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tekst
 text string

Ciąg tekstowy do normalizacji.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator żądania
 request_id string

Identyfikator żądania
SMS
 text string

Oryginalny tekst, który został dostarczony.
sha-256
 sha-256 string

Skrót SHA-256 oryginalnego tekstu.
date
 date array of object

date
Day
 date.day integer

Dzień miesiąca jako liczba całkowita.
Miesiąc
 date.month integer

Miesiąc reprezentowany jako liczba całkowita z zakresu od 1 do 12.
Rok
 date.year integer

Rok reprezentowany jako liczba całkowita.

Pobieranie listy pól

Identyfikator operacji:
GetFieldList

Pobierz listę wszystkich dostępnych pól.

Zwraca

Nazwa Ścieżka Typ Opis
array of object
Identyfikator pola
 field_id string

Unikatowy identyfikator pola.
Name
 name string

Nazwa pola
Description
 description string

Opis pola.
Stronniczość
 bias double

Uprzedzeń używanych przez bazowy model uczenia maszynowego.
Wynik F
 f_score double

Wynik F pola, statystyczna miara jego dokładności.
Precyzja
 precision double

Precyzja pola.
Odwołaj
 recall double

Wycofanie pola.
Liczba dokumentów
 document_count integer

Liczba dokumentów, na których zostało wytrenowane pole.
Czy jest niestandardowy?
 is_custom boolean

Wartość logiczna wskazująca, czy pole jest niestandardowe.
Czy trenowane?
 is_trained boolean

Wartość logiczna wskazująca, czy pole niestandardowe zostało wytrenowane.

Pobieranie obrazów żądań OCR

Identyfikator operacji:
GetOcrRequestImages

Pobierz obrazy z ukończonego żądania OCR.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania OCR
 request_id True string

Unikatowy identyfikator istniejącego żądania OCR zwrócony przez polecenie CreateOcrRequest.

Zwraca

Plik zip zawierający każdą stronę dokumentu jako obraz.

Obrazy
binary

Pobieranie stanu żądania klasyfikacji dokumentów

Identyfikator operacji:
GetDocumentClassificationRequestStatus

Pobierz stan i dostępne wyniki dla istniejącego żądania klasyfikacji dokumentów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 request_id True string

Identyfikator żądania klasyfikacji dokumentów zwrócony przez element CreateDocumentClasssificationRequest.

Zwraca

Nazwa Ścieżka Typ Opis
Stan żądania klasyfikacji
 status string

Stan żądania (jeden z "w kolejce", "przetwarzanie", "complete" lub "failed").
Czy skończysz?
 is_finished boolean

Wartość logiczna wskazująca, czy żądanie osiągnęło stan terminalu (zakończone lub zakończone niepowodzeniem).
Classification
 classification string

Typ wykrytego dokumentu.
Czy kontrakt jest?
 is_contract boolean

Czy dokument został uznany za kontrakt, czy nie.

Pobieranie stanu żądania wyodrębniania pól

Identyfikator operacji:
GetFieldExtractionRequestStatus

Sprawdź stan istniejącego żądania wyodrębniania pól.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania wyodrębniania
 request_id True string

Unikatowy identyfikator istniejącego żądania wyodrębniania zwrócony przez polecenie CreateExtractionRequest.

Zwraca

Nazwa Ścieżka Typ Opis
Stan żądania wyodrębniania pól
 status string

Stan żądania (jeden z "w kolejce", "przetwarzanie", "complete" lub "failed").
Czy skończysz?
 is_finished boolean

Wartość logiczna wskazująca, czy żądanie osiągnęło stan terminalu (zakończone lub zakończone niepowodzeniem).

Pobieranie wyników żądania wyodrębniania pól

Identyfikator operacji:
GetFieldExtractionRequestResults

Pobierz wyniki tekstowe z ukończonego żądania wyodrębniania pól.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania wyodrębniania
 request_id True string

Unikatowy identyfikator istniejącego żądania wyodrębniania zwrócony przez polecenie CreateExtractionRequest.

Zwraca

Nazwa Ścieżka Typ Opis
Results
 results array of object

Tablica wyników wyodrębniania pól.
Identyfikator pola
 results.field_id string

Unikatowy identyfikator wyodrębnionego pola.
Ekstrakcji
 results.extractions array of object

Tablica wyników wyodrębnionych dla tego konkretnego pola.
Tekst
 results.extractions.text string

Tekst wyodrębniony dla pola.
Zakres
 results.extractions.spans array of object

Informacje o lokalizacji tekstu w dokumencie.
Start
 results.extractions.spans.start integer

Indeks pierwszego znaku wyodrębniania w tekście dokumentu.
Koniec
 results.extractions.spans.end integer

Indeks ostatniego znaku wyodrębniania w tekście dokumentu.
Start
 results.extractions.spans.pages.start integer

Numer strony, na której rozpoczyna się wyodrębnianie.
Koniec
 results.extractions.spans.pages.end integer

Numer strony, na której kończy się wyodrębnianie.

Przesyłanie pliku

Identyfikator operacji:
SubmitFile

Prześlij plik do usługi Zuva DocAI.

Parametry

Nazwa Klucz Wymagane Typ Opis
File
 File binary

Zawartość pliku binarnego lub zwykły ciąg tekstowy do przekazania. Zawartość binarna NIE powinna być zakodowana w formacie Base64.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator pliku
 file_id string

Unikatowy identyfikator przypisanego przez Zuva dla pliku.
Typ zawartości
 attributes.content-type string

Wykryto typ zawartości MIME pliku
Wygaśnięcie
 expiration string

Czas, w którym plik ma zostać usunięty z witryny DocAI.

Tworzenie żądania klasyfikacji dokumentów

Identyfikator operacji:
CreateDocumentClassificationRequest

Utwórz żądanie klasyfikacji określonego dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
 file_id string

Unikatowy identyfikator pliku zwrócony przez operację SubmitFile.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator żądania klasyfikacji
 request_id string

Identyfikator używany do uzyskiwania stanu i wyników tego żądania.

Tworzenie żądania klasyfikacji języka

Identyfikator operacji:
CreateLanguageClassificationRequest

Utwórz żądanie dla języka określonego pliku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
 file_id string

Unikatowy identyfikator pliku zwrócony przez operację SubmitFile.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator żądania języka
 request_id string

Identyfikator używany do uzyskiwania stanu i wyników tego żądania.

Tworzenie żądania klasyfikacji na poziomie wielu poziomów

Identyfikator operacji:
CreateMlcRequest

Utwórz żądanie klasyfikacji wieloeziomowej określonego pliku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
 file_id string

Unikatowy identyfikator pliku zwrócony przez operację SubmitFile.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator żądania MLC
 request_id string

Identyfikator używany do uzyskiwania stanu i wyników tego żądania.

Tworzenie żądania OCR

Identyfikator operacji:
CreateOcrRequest

Utwórz nowe żądanie OCR, które ma zostać zastosowane do określonego pliku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
 file_id string

Unikatowy identyfikator pliku zwrócony przez operację SubmitFile.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator żądania OCR
 request_id string

Identyfikator używany do uzyskiwania stanu i wyników żądania OCR.

Tworzenie żądania wyodrębniania pól

Identyfikator operacji:
CreateFieldExtractionRequest

Utwórz nowe żądanie wyodrębniania z określonego pliku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
 file_id string

Plik do wyodrębnienia tekstu.
Identyfikatory pól
 field_ids array of string

Identyfikatory pól do wyodrębnienia.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator żądania wyodrębniania
 request_id string

Identyfikator używany do uzyskiwania stanu i wyników tego żądania.

Usuwanie pliku

Identyfikator operacji:
DeleteFile

Usuń istniejący plik z Zuva.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
 file_id True string

Identyfikator pliku do usunięcia.

Zwraca

response
string

Uzyskiwanie stanu żądania klasyfikacji języka

Identyfikator operacji:
GetLanguageClassificationRequestStatus

Pobierz stan i dostępne wyniki dla istniejącego żądania klasyfikacji dokumentów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 request_id True string

Identyfikator żądania klasyfikacji języka zwrócony przez polecenie CreateLanguageRequest.

Zwraca

Nazwa Ścieżka Typ Opis
Stan żądania języka
 status string

Stan żądania (jeden z "w kolejce", "przetwarzanie", "complete" lub "failed").
Czy skończysz?
 is_finished boolean

Wartość logiczna wskazująca, czy żądanie osiągnęło stan terminalu (zakończone lub zakończone niepowodzeniem).
Język
 language string

Podstawowy wykryty język dokumentu.

Uzyskiwanie stanu żądania MLC

Identyfikator operacji:
GetMlcRequestStatus

Pobierz stan i dostępne wyniki dla istniejącego żądania MLC.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 request_id True string

Identyfikator żądania MLC zwrócony przez polecenie CreateMlcRequest.

Zwraca

Nazwa Ścieżka Typ Opis
Stan żądania MLC
 status string

Stan żądania (jeden z "w kolejce", "przetwarzanie", "complete" lub "failed").
Czy skończysz?
 is_finished boolean

Wartość logiczna wskazująca, czy żądanie osiągnęło stan terminalu (zakończone lub zakończone niepowodzeniem).
Classifications
 classifications array of string

Hierarchiczne klasyfikacje dokumentu.

Uzyskiwanie stanu żądania OCR

Identyfikator operacji:
GetOcrRequestStatus

Sprawdź stan istniejącego żądania OCR.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania OCR
 request_id True string

Unikatowy identyfikator istniejącego żądania OCR zwrócony przez polecenie CreateOcrRequest.

Zwraca

Nazwa Ścieżka Typ Opis
Stan żądania OCR
 status string

Stan żądania (jeden z "w kolejce", "przetwarzanie", "complete" lub "failed").
Czy skończysz?
 is_finished boolean

Wartość logiczna wskazująca, czy żądanie osiągnęło stan terminalu (zakończone lub zakończone niepowodzeniem).

Uzyskiwanie tekstu żądania OCR

Identyfikator operacji:
GetOcrRequestText

Pobierz tekst z ukończonego żądania OCR.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania OCR
 request_id True string

Unikatowy identyfikator istniejącego żądania OCR zwrócony przez polecenie CreateOcrRequest.

Zwraca

Nazwa Ścieżka Typ Opis
Tekst
 text string

Tekst OCR dokumentu.

Definicje

ciąg

Jest to podstawowy typ danych "string".

binarny

Jest to podstawowy typ danych "binary".