UIP-Dokumente in IXP & Beschriftungen

Syntax und Optionen für „uip ixp documents“ und „uip ixp labelleds“, die Trainingsdokumente verwalten und die Vorhersagen des Modells darauf überprüfen/bestätigungen.

uip ixp documents verwaltet die unformatierten Trainingsdokumente eines Projekts (Upload/Download/Löschen/Liste). uip ixp labellings überprüft und bestätigt die Vorhersagen des Modells für diese Dokumente – der Human-in-the-Loop-Schritt, der Ground Truth für das erneute Training erzeugt. Wie dies in die Trainingsschleife passt, finden Sie unter Konzepte auf der übergeordneten Seite.

Zusammenfassung

uip ixp documents list <project-name> [-l, --limit <n>] [--offset <n>]
uip ixp documents download <project-name> <document-id> [-o, --output <path>]
uip ixp documents upload <project-name> <file>
uip ixp documents delete <project-name> <document-id> -y

uip ixp labellings confirm <project-name> [document-id] [-f, --fields <ids>] [-c, --corrections <json>] [--group <name>] [--occurrence <n>] [--updates <json>] [-m, --model-version <n>]
uip ixp labellings unconfirm <project-name> <document-id> [-f, --fields <ids>] [--group <name>] [--occurrence <n>] [--updates <json>]
uip ixp labellings mark-missing <project-name> <document-id> -f, --fields <ids>
uip ixp labellings get-predictions <project-name> [document-id]

UIP-Dokumente für Intelligente Datenextraktion und Verarbeitung (IXP).

Lesen Sie den Inhalt des Dokuments IXP.

Liste der UIP-IXP-Dokumente

Listet alle Dokumente in einem Projekt auf.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Short	Long	Wert	Standard	Beschreibung
-l	--limit <number>	1-10.000	50	Anzahl der zurückzugebenden Elemente.
–	--offset <number>	0-1000000	0	Anzahl der zu überspringenden Elemente.

Beispiele

uip ixp documents list my-invoices

uip ixp documents list my-invoices --limit 100 --offset 100

Datenform (--output json)

{
  "Code": "IxpDocumentsList",
  "Data": {
    "Documents": [
      { "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21", "AttachmentRef": "c1a7e9d3-8b2f-4e60-9a15-7d3c6f0b4e28", "Filename": "invoice-001.pdf" }
    ],
    "Total": 120,
    "Offset": 0,
    "Limit": 50
  }
}

UIP IXP Dokumente herunterladen

Originaldokumentdatei herunterladen (PDF/PNG/JPG/etc.) zum Anzeigen. Die Erweiterung der Datei wird automatisch korrigiert, um dem echten Inhaltstyp zu entsprechen, den der Server meldet – sie vertraut der Erweiterung von --output nicht.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
<document-id>	ja	Dokument-ID.

Optionen

Short	Long	Wert	Standard	Beschreibung
-o	--output <path>	Pfad	einen generierten tmpir-Pfad	Pfad der Ausgabedatei. Die Erweiterung wird automatisch korrigiert (z. B .jpeg/.tiff werden als gleichwertig mit .jpg/.tif akzeptiert, andernfalls wird eine nicht übereinstimmende oder fehlende Erweiterung ersetzt/angefügt.

Beispiel

uip ixp documents download my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 -o ./doc

Datenform (--output json)

{
  "Code": "IxpDocumentsDownload",
  "Data": { "Path": "./doc.pdf", "ContentType": "application/pdf", "SizeBytes": 102400 }
}

UIP-IXP-Dokumente hochladen

Eine Dokumentdatei in ein vorhandenes Projekt hochladen. Weist Client-Seite nicht unterstützte Dateierweiterungen vor jedem Netzwerkaufruf zurück.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
<file>	ja	Pfad zur hochzuladenden Dokumentdatei.

Beispiel

uip ixp documents upload my-invoices ./invoice.pdf

Datenform (--output json)

{
  "Code": "IxpDocumentsUpload",
  "Data": {
    "ProjectName": "my-invoices",
    "Filename": "invoice.pdf",
    "AttachmentRef": "c1a7e9d3-8b2f-4e60-9a15-7d3c6f0b4e28",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21"
  }
}

UIP IXP-Dokumente löschen

Ein Dokument aus einem Projekt löschen.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
<document-id>	ja	Dokument-ID.

Optionen

Short	Long	Erforderlich	Beschreibung
-y	--yes	ja	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang.

Beispiel

uip ixp documents delete my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

Datenform (--output json)

{ "Code": "IxpDocumentsDelete", "Data": { "Status": "ok" } }

Beschriftungen für UIP-IXP

IXP-Beschriftungen und -Vorhersagen verwalten – der menschliche Überprüfungsschritt, der Modellvorhersagen in bestätigte Referenzdaten umwandelt.

Hinweis:

confirm und get-predictions akzeptieren ein optionales [document-id] – wenn sie weggelassen werden, wird der Vorgang auf jedes Dokument im Projekt angewendet. Dieses projektweite Formular ist veraltet und wird in einer zukünftigen Version entfernt; eine [WARN] -Zeile wird in standardisiert, wenn Sie sie weglassen (stdout bleibt für --output json -Skripting parsbar). Übergeben Sie eine Dokument-ID, die über uip ixp documents list gefunden wurde.

Wiederholbare Feldgruppen: Zielvorkommen

Für eine wiederholbare Feldgruppe (z. B "Zeilenelemente" mit einem Vorkommen pro Rechnungszeile), haben confirm und unconfirm über --group ein gemeinsames Zielmodell:

Flaggen	Auswirkung
--group <name> allein	Ziel ist jedes Vorkommen der Gruppe.
--group <name> --occurrence <n>	Ziel ist genau ein Vorkommen (0-basierter Index) – das einzeilige autonome Formular. Erfordert --group und eine Dokument-ID.
--group <name> --updates <json>	Zielt auf mehrere spezifische Vorkommen in einem atomaren Aufruf: [{"occurrence":<n>,"fields"?:[...],"corrections"?:{...}}] (Bestätigung) oder [{"occurrence":<n>,"fields"?:[...]}] (Bestätigung aufheben). --updates ist die Obermenge – --occurrence <n> entspricht einem --updates mit einem einzelnen Eintrag. Sich gegenseitig ausschließend mit --occurrence, --fields und (für confirm) --corrections.

--group muss der vollständige Beschriftungspfad sein, genau wie im Feld Name der get-predictions -Ausgabe gezeigt (z. B "Invoice > Line Items"), nicht nur der Blattname.

UIP IXP-Beschriftungen bestätigen

Bestätigen Sie von IXP generierte Vorhersagen als Ground Truth für ein Dokument.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
[document-id]	nein	Dokument-ID. Wenn Sie sie weglassen, wird jedes Dokument im Projekt bestätigt – veraltet.

Optionen

Short	Long	Wert	Beschreibung
-f	--fields <field-ids>	durch Kommas getrennt sind	Zu bestätigende Feld-IDs. Lassen Sie es weg, um alle vorhergesagten Felder zu bestätigen. Bestätigt ohne --group jede Feld-ID für jedes Vorkommen, in dem es erscheint; mit --group --occurrence bestätigt, nur innerhalb dieses Vorkommens.
-c	--corrections <json>	JSON-Array	Überschreiben von vorhergesagten Werten unter Beibehalten von Referenzen: [{"field_id":"...","value":"corrected"}]. Gilt für jedes Vorkommen, in dem das Feld erscheint (oder für das Zielvorkommen). Sich gegenseitig mit --updates ausschließen.
–	--group <name>	string	Zielfeldgruppe – siehe Zieltabelle oben.
–	--occurrence <index>	Integer	Index für einmaliges Vorkommen innerhalb von --group. Siehe Zieltabelle oben.
–	--updates <json>	JSON-Array	Batch-Formular für mehrere Vorkommen. Siehe Zieltabelle oben.
-m	--model-version <version>	nicht negativer Integer	Optimist-concurrence Guard: Die Modellversion (von get-predictions' ModelVersion), für die die Vorhersagen überprüft wurden. Wenn ein erneutes Training seither eine neuere Version erzeugt hat, wird die Bestätigung abgelehnt , anstatt die abgeleiteten Werte als Ground Truth zu stempeln. Auslassen, um die Prüfung zu überspringen.

Beispiele

# Confirm a single document with a field filter and a correction
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940 -c '[{"field_id":"a7c3e9105f2b4d86","value":"INV-7654321"}]'

# Confirm all predicted fields on a document as-is
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

# Confirm every occurrence of a repeatable group
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 --group "Line Items"

# Single occurrence
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  --group "Line Items" --occurrence 2

# Batched: confirm one field in two specific occurrences, in one atomic call
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  --group "Loan and Property" --updates '[{"occurrence":0,"fields":["e9b1746c0a2f5d83"]},{"occurrence":2,"fields":["e9b1746c0a2f5d83"]}]'

Datenform (--output json)

{
  "Code": "IxpLabellingsConfirm",
  "Data": { "ProjectName": "my-invoices", "TotalDocuments": 1, "PredictionsConfirmed": 1 }
}

TotalDocuments/PredictionsConfirmed zählen Dokumente, keine Felder (PredictionsConfirmed ist 0 oder 1 pro Dokument – dadurch wird der Legacy-CLI-Vertrag pro Dokument beibehalten, auch wenn die zugrunde liegende Anzahl der Felder höher sein kann).

UIP IXP-Beschriftungen nicht bestätigen

Bestätigungen aus einem Dokument entfernen – Die Zielfelder werden wieder ohne Anmerkungen versehen. Verwenden Sie, um ein fehlerhaftes confirm/mark-missing zurückzusetzen. Jede andere Anmerkung im Dokument wird übertragen. Teilt das Zielmodell --group/--occurrence/--updates von confirm (siehe Tabelle oben), abzüglich --corrections/--model-version.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
<document-id>	ja	Dokument-ID.

Optionen

Short	Long	Wert	Beschreibung
-f	--fields <field-ids>	durch Kommas getrennt sind	Feld-IDs, für die die Bestätigung aufgehoben werden soll.
–	--group <name>	string	Zielfeldgruppe.
–	--occurrence <index>	Integer	Index für einzelne Vorkommen.
–	--updates <json>	JSON-Array	Batch-Formular für mehrere Vorkommen: [{"occurrence":<n>,"fields"?:[...]}].

Mindestens eines von --fields/--group ist erforderlich – das implizite Aufheben der Bestätigung eines gesamten Dokuments ist nicht zulässig.

Beispiele

uip ixp labellings unconfirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940

uip ixp labellings unconfirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 --group "Line Items"

Datenform (--output json)

{
  "Code": "IxpLabellingsUnconfirm",
  "Data": {
    "ProjectName": "my-invoices",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21",
    "FieldsUnconfirmed": 2,
    "Unmatched": []
  }
}

Markierung für UIP-IXP-Beschriftungen fehlt

Felder in einem Dokument als fehlend markieren – mit Anmerkungen als ohne Wert und ohne Speicherort versehen. Verwenden Sie es, wenn das Feld wirklich fehlt.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
<document-id>	ja	Dokument-ID.

Optionen

Short	Long	Wert	Erforderlich	Beschreibung
-f	--fields <field-ids>	durch Kommas getrennt sind	ja	Feld-IDs, die als fehlend markiert werden sollen.

Beispiel

uip ixp labellings mark-missing my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940

Datenform (--output json)

{
  "Code": "IxpLabellingsMarkMissing",
  "Data": {
    "ProjectName": "my-invoices",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21",
    "FieldsMarked": 2,
    "Unmatched": []
  }
}

UIP IXP-Beschriftungen für Get-Vorhersagen

Rufen Sie IXP-Modellvorhersagen für Dokumente in einem Projekt ab – vorhergesagte Beschriftungen und Feldwerte sowie den ModelVersion, der sie erzeugt hat (null, wenn ein Dokument noch keine Vorhersagen hat).

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
[document-id]	nein	Dokument-ID. Sie wird über jedes Dokument im Projekt hinweg weggelassen – veraltet.

Beispiele

uip ixp labellings get-predictions my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

Datenform (--output json)

{
  "Code": "IxpLabellingsGetPredictions",
  "Data": { "ProjectName": "my-invoices", "TotalDocuments": 1, "DocumentsWithPredictions": 1, "Predictions": [] }
}

Predictions Einträge behalten das native PascalCase der API bei, einschließlich eines Occurrence -Index pro Beschriftung für wiederholbare Gruppen.

Zugehörig

• uip IXP – Konzepte und das vollständige Ressourcenverzeichnis.
• uip IXP-Projekte – get-metrics zur Überprüfung der Beschriftungsqualität; publish zum Versenden eines neu trainierten Modells.
• uip IXP Taxonomy – Die Feld-/Gruppenvorhersagen werden hier bewertet.

Siehe auch

• Übersicht über das IXP-Tool
• Globale Optionen
• Exitcodes