Freigeben über


Zuva DocAI

Betten Sie Ai mit Zuva DocAI in Ihre Produktworkflows ein. Nutzen Sie die DocAI-APIs nicht, um Informationen aus Ihren Verträgen zu extrahieren.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Zuva-Unterstützung
URL https://zuva.ai/support/
Email support@zuva.ai
Connectormetadaten
Herausgeber Zuva Inc.
Webseite https://zuva.ai/
Datenschutzrichtlinie https://zuva.ai/privacy/
Kategorien Künstliche Intelligenz

Dieser Connector ermöglicht Benutzern das Auffinden und Extrahieren von Entitäten, Sätzen und Absätzen aus Verträgen (und verwandten Dokumenten), wobei zuva's best-in-class Contracts AI verwendet wird. Dieser Connector wurde entwickelt und geschult, um Rechtsklauseln in mehreren Branchen und Anwendungsfällen anzuheften, bietet dieser Connector eine Plug-and-Play-Suite von Modulen, um Verträge AI in Ihre Workflows einzubetten. Dieser Connector enthält OCR zum Lesen Ihrer Dokumente sowie Dokumentklassifizierungs- und Normalisierungsfunktionen.

Voraussetzungen

Sie benötigen ein Zuva-Konto und ein DocAI-Token. Beginnen Sie, indem Sie sich für ein kostenloses Konto registrieren.

So erhalten Sie Anmeldeinformationen

Zuva DocAI verfügt über mehrere regionale Server. Sie müssen ein API-Token für die bestimmte Region erstellen, die Sie verwenden möchten.

  1. Erstellen Und/oder melden Sie sich bei Ihrem Konto bei zuva.ai an.
  2. Navigieren Zur DocAI-Konsole
  3. Wählen Sie die Region aus, die Sie verwenden möchten.
  4. Kopieren Sie die Basis-URL für die Region in Ihre Verbindung.
  5. Erstellen Sie ein Token, und kopieren Sie es, um es in Ihrer Verbindung zu verwenden.

Weitere Informationen zu Zuva-Konten und Token finden Sie im DocAI-Schnellstarthandbuch .

Erste Schritte mit Ihrem Connector

Um den Zuva DocAI-Connector zu verwenden, müssen Sie einen Fluss wie folgt festlegen:

Schritt 1: Abrufen einer Datei

Zu Testzwecken können Sie einen "Instant Cloud Flow" in Power Automate erstellen. Wählen Sie "Manuell einen Fluss auslösen" aus, und erstellen Sie den Fluss. Fügen Sie eine Eingabe hinzu, und wählen Sie den Typ "Datei" aus.

Schritt 2: Übermitteln einer Datei

Fügen Sie die Submit a file Aktion hinzu, und wählen Sie den "Dateiinhalt" aus dem vorherigen Schritt als Eingabe aus.

Hinweis: Die Datei sollte nicht auf irgendeine Weise transformiert werden (d. h. keine Base64-Codierung). DocAI akzeptiert nur unformatierte Binärdaten.

Schritt 3: Starten der Verarbeitung der Datei

Wählen Sie aus, welchen Dienst Sie verwenden möchten, indem Sie eine der folgenden Aktionen hinzufügen:

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

Jede dieser Werte akzeptiert die Datei-ID (die von der Submit a file Aktion zurückgegeben wird) als Eingabe.

Für die Feldextraktion sind zusätzlich Feld-IDs als Eingaben erforderlich. Feld-IDs finden Sie in der Feldbibliothek (Anmeldung erforderlich), von AI-Trainer , wenn Sie benutzerdefinierte Felder trainiert haben oder programmgesteuert die Get Field List Aktion verwenden.

Schritt 4: Umfrage zum Abschluss der Anforderung

Verwenden Sie einen Do Until Block (im Abschnitt "Steuerelement" gefunden), und fügen Sie der Inneren des Blocks die richtige Statusüberprüfungsaktion hinzu:

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

Die Get ____ status Aktion wird als Eingabe der Anforderungs-ID aus der entsprechenden Create ____ Request Aktion ausgeführt.

Sie sollten auch einen 10-Sekunden-Block Delay innerhalb des Do until Blocks hinzufügen, um sicherzustellen, dass die Datei ausreichend Zeit zum Verarbeiten hat.

Legen Sie die Bedingung für den Do Until Block Is Finished? gleich .true

Schritt 4: Abrufen von Ergebnissen

Verwenden Sie schließlich eine der "Ergebnisse abrufen"-Aktion, die Ihrer Anforderung entspricht, und verwenden Sie die Anforderungs-ID aus dem ursprünglichen Erstellungsvorgang als Eingabe:

  • 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

Beachten Sie, dass die Ergebnisse für Sprache, Dokumentklassifizierung und MLC in der Statusantwort enthalten sind.

Weitere Informationen zur Struktur der Feldextraktionsergebnisse finden Sie in der DocAI-Dokumentation .

Bekannte Probleme und Einschränkungen

Felder pro Anforderung

Maximal 100 Felder können in einer einzigen Create Field Extraction Request Aktion enthalten sein.

Benutzerdefinierte Felder

Der Connector unterstützt keine Endpunkte von DocAI im Zusammenhang mit der Schulung von benutzerdefinierten Feldern oder das Abrufen der Metadaten eines einzelnen Felds.

Unterschiede bei der zugrunde liegenden API

Beachten Sie außerdem, dass die Connectorfunktion nicht 1:1 mit der Dokumentation für die zugrunde liegende API übereinstimmt. Insbesondere der Verbinder:

  1. Macht einen zusätzlichen is_finished booleschen Wert verfügbar, der verwendet werden kann, um festzustellen, ob die Anforderung abgeschlossen oder fehlgeschlagen ist.
  2. Alle Anforderungen werden auf einzelnen Dateien und nicht auf Batches mehrerer Dateien ausgeführt.

Häufige Fehler und Abhilfemaßnahmen

Laden Sie nicht base64-codierte Zeichenfolgen, sondern unformatierte Binärdateien hoch. Sie können den OCR-Dienst verwenden und überprüfen, ob er den erwarteten Text zurückgibt.

Häufig gestellte Fragen

Wo finde ich weitere Informationen zu Zuva DocAI?

https://zuva.ai/docai/

Wo finde ich zusätzliche Dokumentation zu Zuva DocAI?

https://zuva.ai/documentation/

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Token securestring Ihr DocAI-Token Richtig
Stamm-URL Schnur zum Beispiel. https://us.app.zuva.ai/api/v2 Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen des Anforderungsstatus der Sprachklassifizierung

Abrufen des Status und verfügbarer Ergebnisse für eine vorhandene Dokumentklassifizierungsanforderung.

Abrufen des Feldextraktionsanforderungsstatus

Überprüfen Sie den Status einer vorhandenen Feldextraktionsanforderung.

Abrufen von Feldextraktionsanforderungsergebnissen

Abrufen von Textergebnissen aus einer abgeschlossenen Feldextraktionsanforderung.

Abrufen von OCR-Anforderungsbildern

Rufen Sie die Bilder aus einer abgeschlossenen OCR-Anforderung ab.

Erstellen einer Dokumentklassifizierungsanforderung

Erstellen Sie eine Anforderung für die Klassifizierung des angegebenen Dokuments.

Erstellen einer Feldextraktionsanforderung

Erstellen Sie eine neue Anforderung für Extraktionen aus der angegebenen Datei.

Erstellen einer Mehrebenenklassifizierungsanforderung

Erstellen Sie eine Anforderung für die Mehrebenenklassifizierung der angegebenen Datei.

Erstellen einer OCR-Anforderung

Erstellen Sie eine neue Anforderung für OCR, die auf die angegebene Datei angewendet werden soll.

Erstellen einer Sprachklassifizierungsanforderung

Erstellen Sie eine Anforderung für die Sprache der angegebenen Datei.

Feldliste abrufen

Dient zum Abrufen einer Liste aller für Sie verfügbaren Felder.

Löschen einer Datei

Löschen Sie eine vorhandene Datei aus Zuva.

MLC-Anforderungsstatus abrufen

Abrufen von Status und verfügbaren Ergebnissen für eine vorhandene MLC-Anforderung.

Normalisieren von Datumsangaben

Normalisieren Sie eine Zeichenfolge, die ein oder mehrere Datumsangaben enthält. Für jedes gefundene Datum gibt der Endpunkt eine Reihe ganzzahliger Zahlen zurück, die das Jahr, den Monat und den Tag darstellen.

OCR-Anforderungsstatus abrufen

Überprüfen Sie den Status einer vorhandenen OCR-Anforderung.

OCR-Anforderungstext abrufen

Rufen Sie den Text aus einer abgeschlossenen OCR-Anforderung ab.

Senden einer Datei

Übermitteln Sie eine Datei an Zuva DocAI.

Status der Dokumentklassifizierungsanforderung abrufen

Abrufen des Status und verfügbarer Ergebnisse für eine vorhandene Dokumentklassifizierungsanforderung.

Abrufen des Anforderungsstatus der Sprachklassifizierung

Abrufen des Status und verfügbarer Ergebnisse für eine vorhandene Dokumentklassifizierungsanforderung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anfrage-ID
request_id True string

Anforderungs-ID der Sprachklassifizierungsanforderung, wie von CreateLanguageRequest zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
Status der Sprachanforderung
status string

Status der Anforderung (einer von 'queued', 'processing', 'complete' oder 'failed').

Ist fertig?
is_finished boolean

Boolescher Wert, der angibt, ob die Anforderung einen Terminalstatus erreicht hat (abgeschlossen oder fehlgeschlagen).

Language
language string

Die primäre erkannte Sprache des Dokuments.

Abrufen des Feldextraktionsanforderungsstatus

Überprüfen Sie den Status einer vorhandenen Feldextraktionsanforderung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Extraktionsanforderungs-ID
request_id True string

Eindeutiger Identifer einer vorhandenen Extraktionsanforderung, wie von CreateExtractionRequest zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
Feldextraktionsanforderungsstatus
status string

Status der Anforderung (einer von 'queued', 'processing', 'complete' oder 'failed').

Ist fertig?
is_finished boolean

Boolescher Wert, der angibt, ob die Anforderung einen Terminalstatus erreicht hat (abgeschlossen oder fehlgeschlagen).

Abrufen von Feldextraktionsanforderungsergebnissen

Abrufen von Textergebnissen aus einer abgeschlossenen Feldextraktionsanforderung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Extraktionsanforderungs-ID
request_id True string

Eindeutiger Identifer einer vorhandenen Extraktionsanforderung, wie von CreateExtractionRequest zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
Ergebnisse
results array of object

Ein Array der Ergebnisse der Feldextraktion.

Feld-ID
results.field_id string

Der eindeutige Bezeichner für das extrahierte Feld.

Extrakte
results.extractions array of object

Ein Array von Ergebnissen, die für dieses bestimmte Feld extrahiert wurden.

Text
results.extractions.text string

Der Text, der für das Feld extrahiert wurde.

Spans
results.extractions.spans array of object

Informationen zur Position des Texts im Dokument.

Start
results.extractions.spans.start integer

Der Index des ersten Zeichens der Extraktion innerhalb des Dokumenttexts.

ENDE
results.extractions.spans.end integer

Der Index des letzten Zeichens der Extraktion innerhalb des Dokumenttexts.

Start
results.extractions.spans.pages.start integer

Die Seitenzahl, auf der die Extraktion beginnt.

ENDE
results.extractions.spans.pages.end integer

Die Seitenzahl, auf der die Extraktion endet.

Abrufen von OCR-Anforderungsbildern

Rufen Sie die Bilder aus einer abgeschlossenen OCR-Anforderung ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
OCR-Anforderungs-ID
request_id True string

Eindeutiger Identifer einer vorhandenen OCR-Anforderung, wie von CreateOcrRequest zurückgegeben.

Gibt zurück

Eine ZIP-Datei, die jede Seite des Dokuments als Bild enthält.

Bilder
binary

Erstellen einer Dokumentklassifizierungsanforderung

Erstellen Sie eine Anforderung für die Klassifizierung des angegebenen Dokuments.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei-ID
file_id string

Der eindeutige Bezeichner für die Datei, wie vom SubmitFile-Vorgang zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
Klassifizierungsanforderungs-ID
request_id string

ID, die zum Abrufen des Status und der Ergebnisse dieser Anforderung verwendet werden soll.

Erstellen einer Feldextraktionsanforderung

Erstellen Sie eine neue Anforderung für Extraktionen aus der angegebenen Datei.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei-ID
file_id string

Die Datei, aus der Text extrahiert werden soll.

Feld-IDs
field_ids array of string

Die IDs der zu extrahierenden Felder.

Gibt zurück

Name Pfad Typ Beschreibung
Extraktionsanforderungs-ID
request_id string

ID, die zum Abrufen des Status und der Ergebnisse dieser Anforderung verwendet werden soll.

Erstellen einer Mehrebenenklassifizierungsanforderung

Erstellen Sie eine Anforderung für die Mehrebenenklassifizierung der angegebenen Datei.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei-ID
file_id string

Der eindeutige Bezeichner für die Datei, wie vom SubmitFile-Vorgang zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
MLC-Anforderungs-ID
request_id string

ID, die zum Abrufen des Status und der Ergebnisse dieser Anforderung verwendet werden soll.

Erstellen einer OCR-Anforderung

Erstellen Sie eine neue Anforderung für OCR, die auf die angegebene Datei angewendet werden soll.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei-ID
file_id string

Der eindeutige Bezeichner für die Datei, wie vom SubmitFile-Vorgang zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
OCR-Anforderungs-ID
request_id string

ID, die zum Abrufen des Status und der Ergebnisse der OCR-Anforderung verwendet wird.

Erstellen einer Sprachklassifizierungsanforderung

Erstellen Sie eine Anforderung für die Sprache der angegebenen Datei.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei-ID
file_id string

Der eindeutige Bezeichner für die Datei, wie vom SubmitFile-Vorgang zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
Sprachanforderungs-ID
request_id string

ID, die zum Abrufen des Status und der Ergebnisse dieser Anforderung verwendet werden soll.

Feldliste abrufen

Dient zum Abrufen einer Liste aller für Sie verfügbaren Felder.

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Feld-ID
field_id string

Der eindeutige Bezeichner für das Feld.

Name
name string

Der Name des Felds

Description
description string

Eine Beschreibung des Felds.

Vorurteil
bias double

Die vom zugrunde liegenden ML-Modell verwendete Verzerrung.

F-Bewertung
f_score double

Die F-Bewertung des Felds, ein statistisches Maß für seine Genauigkeit.

Präzision
precision double

Die Genauigkeit des Felds.

Abruf
recall double

Der Rückruf des Felds.

Dokumentanzahl
document_count integer

Die Anzahl der Dokumente, auf die das Feld trainiert wurde.

Ist benutzerdefiniert?
is_custom boolean

Boolescher Wert, der angibt, ob das Feld benutzerdefiniert ist.

Ist trainiert?
is_trained boolean

Boolescher Wert, der angibt, ob ein benutzerdefiniertes Feld trainiert wurde.

Löschen einer Datei

Löschen Sie eine vorhandene Datei aus Zuva.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei-ID
file_id True string

ID der zu löschenden Datei.

Gibt zurück

response
string

MLC-Anforderungsstatus abrufen

Abrufen von Status und verfügbaren Ergebnissen für eine vorhandene MLC-Anforderung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anfrage-ID
request_id True string

Anforderungs-ID der MLC-Anforderung, wie von CreateMlcRequest zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
MLC-Anforderungsstatus
status string

Status der Anforderung (einer von 'queued', 'processing', 'complete' oder 'failed').

Ist fertig?
is_finished boolean

Boolescher Wert, der angibt, ob die Anforderung einen Terminalstatus erreicht hat (abgeschlossen oder fehlgeschlagen).

Classifications
classifications array of string

Die hierarchischen Klassifizierungen des Dokuments.

Normalisieren von Datumsangaben

Normalisieren Sie eine Zeichenfolge, die ein oder mehrere Datumsangaben enthält. Für jedes gefundene Datum gibt der Endpunkt eine Reihe ganzzahliger Zahlen zurück, die das Jahr, den Monat und den Tag darstellen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Text
text string

Die zu normalisierende Textzeichenfolge.

Gibt zurück

Name Pfad Typ Beschreibung
Anfrage-ID
request_id string

ID der Anforderung

Text
text string

Der ursprüngliche Text, der bereitgestellt wurde.

sha-256
sha-256 string

SHA-256-Hash des ursprünglichen Texts.

date
date array of object

date

Day
date.day integer

Der Tag des Monats als ganze Zahl.

Month
date.month integer

Der Monat, der als ganze Zahl zwischen 1 und 12 dargestellt wird.

Jahr
date.year integer

Das Jahr, das als ganze Zahl dargestellt wird.

OCR-Anforderungsstatus abrufen

Überprüfen Sie den Status einer vorhandenen OCR-Anforderung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
OCR-Anforderungs-ID
request_id True string

Eindeutiger Identifer einer vorhandenen OCR-Anforderung, wie von CreateOcrRequest zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
OCR-Anforderungsstatus
status string

Status der Anforderung (einer von 'queued', 'processing', 'complete' oder 'failed').

Ist fertig?
is_finished boolean

Boolescher Wert, der angibt, ob die Anforderung einen Terminalstatus erreicht hat (abgeschlossen oder fehlgeschlagen).

OCR-Anforderungstext abrufen

Rufen Sie den Text aus einer abgeschlossenen OCR-Anforderung ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
OCR-Anforderungs-ID
request_id True string

Eindeutiger Identifer einer vorhandenen OCR-Anforderung, wie von CreateOcrRequest zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
Text
text string

OCR-Text des Dokuments.

Senden einer Datei

Übermitteln Sie eine Datei an Zuva DocAI.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei
File binary

Binärdateiinhalt oder Nur-Text-Zeichenfolge, die hochgeladen werden soll. Binärer Inhalt sollte NICHT base64-codiert sein.

Gibt zurück

Name Pfad Typ Beschreibung
Datei-ID
file_id string

Der eindeutige Zuva-Bezeichner für die Datei.

Inhaltstyp
attributes.content-type string

Erkannter MIME-Inhaltstyp der Datei

Ablaufdatum
expiration string

Der Zeitpunkt, zu dem die Datei aus DocAI gelöscht werden soll.

Status der Dokumentklassifizierungsanforderung abrufen

Abrufen des Status und verfügbarer Ergebnisse für eine vorhandene Dokumentklassifizierungsanforderung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anfrage-ID
request_id True string

Anforderungs-ID der Dokumentklassifizierungsanforderung, wie von CreateDocumentClasssificationRequest zurückgegeben.

Gibt zurück

Name Pfad Typ Beschreibung
Status der Klassifizierungsanforderung
status string

Status der Anforderung (einer von 'queued', 'processing', 'complete' oder 'failed').

Ist fertig?
is_finished boolean

Boolescher Wert, der angibt, ob die Anforderung einen Terminalstatus erreicht hat (abgeschlossen oder fehlgeschlagen).

Klassifizierung
classification string

Der Typ des dokuments, das erkannt wurde.

Ist Vertrag?
is_contract boolean

Gibt an, ob das Dokument als Vertrag erkannt wurde oder nicht.

Definitionen

Schnur

Dies ist der grundlegende Datentyp "string".

binär

Dies ist der grundlegende Datentyp "binary".