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

Syntax und Optionen für „uip ixp processes“, die IXP-Trainingsprojekte erstellen und verwalten – Modellveröffentlichung, Metriken und Taxonomie-Import/Export.

uip ixp projects erstellt und verwaltet IXP-Trainingsprojekte: den Container der obersten Ebene für eine Taxonomie, Trainingsdokumente und trainierte Modellversionen. Unter Konzepte auf der übergeordneten Seite finden Sie das Taxonomiemodell und die Trainingsschleife – Übersicht.

Zusammenfassung

uip ixp projects list [-l, --limit <n>] [--offset <n>]
uip ixp projects get <project-name>
uip ixp projects delete <project-name> -y
uip ixp projects update-title <project-name> <new-title>
uip ixp projects update-prompt <project-name> --prompt <text>
uip ixp projects get-taxonomy <project-name>
uip ixp projects import-taxonomy <project-name> <file>
uip ixp projects configure-model <project-name> [--model <version>] [--preprocessing <type>]
uip ixp projects get-metrics <project-name> [-m, --model-version <version>]
uip ixp projects publish <project-name> [-m, --model-version <version>] [--tag live|staging] [-d, --description <text>]
uip ixp projects unpublish <project-name> -m, --model-version <version>
uip ixp projects untag <project-name> --tag live|staging
uip ixp projects list-models <project-name>
uip ixp projects create <name> [folder-path] [-d, --description <text>] [--skip-taxonomy]

UIP-IXP-Projektliste

Listen Sie alle Intelligente Datenextraktion und Verarbeitung (IXP)-Trainingsprojekte im Mandanten auf.

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.

Beispiel

uip ixp projects list

Datenform (--output json)

{
  "Code": "IxpProjectsList",
  "Data": {
    "Projects": [
      {
        "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
        "Name": "my-invoices",
        "Title": "My Invoices",
        "CreatedAt": "2026-04-01T10:00:00Z",
        "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
      }
    ],
    "Total": 1,
    "Offset": 0,
    "Limit": 1
  }
}

Die gesamte Antwort, einschließlich Data, wird vom IXP API-Verbatim weitergeleitet – die Schlüssel behalten ihren nativen PascalCase hier bei, aber sehen Sie sich die Anmerkungen jedes anderen Verbs zur Groß-/Kleinschreibung an, da sie je nach Endpunkt variiert.

UIP-IXP-Projekte abrufen

Rufen Sie ein Intelligente Datenextraktion und Verarbeitung (IXP)-Trainingsprojekt nach Namen ab.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Beispiel

uip ixp projects get my-invoices

Datenform (--output json)

{
  "Code": "IxpProjectsGet",
  "Data": {
    "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
    "Name": "my-invoices",
    "Title": "My Invoices",
    "CreatedAt": "2026-04-01T10:00:00Z",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
  }
}

UIP-IXP-Projekte löschen

Löschen Sie ein Projekt endgültig – seine Dokumente, die Taxonomie und trainierte Modelle. irreversibel; erfordert --yes.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Short	Long	Beschreibung
-y	--yes	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.

Beispiel

uip ixp projects delete my-invoices --yes

Datenform (--output json)

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

UIP-IXP-Projekte Update-Titel

Aktualisieren Sie den Anzeigetitel eines Projekts. Der Proxy hält die Dataset- und Projekttitel serverseitig synchron.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
<new-title>	ja	Neuer Anzeigetitel.

Beispiel

uip ixp projects update-title my-invoices "My Invoices"

Datenform (--output json)

{
  "Code": "IxpProjectsUpdateTitle",
  "Data": {
    "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
    "Name": "my-invoices",
    "Title": "My Invoices",
    "CreatedAt": "2026-04-01T10:00:00Z",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
  }
}

Aktualisierungsaufforderung für UIP-IXP-Projekte

Aktualisieren Sie die allgemeinen Extraktionsanweisungen des Projekts – den taxonomieweiten Prompt, der den Modellkontext für jede Feldgruppe relevant macht. Entspricht den „Allgemeinen Extraktionsanweisungen“ der IXP-Benutzeroberfläche auf der Seite Taxonomie- verwalten. Unterscheiden Sie sich von dem eigenen Prompt einer Feldgruppe (taxonomy groups update-prompts) und den Prompts pro Feld (taxonomy fields update-prompts).

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Long	Wert	Erforderlich	Beschreibung
--prompt <text>	string	ja	Neue allgemeine Extraktionsanweisungen. Ersetzt den vorhandenen Wert.

Beispiel

uip ixp projects update-prompt my-invoices --prompt "Extract key information from US vendor invoices, including header fields and line items."

Datenform (--output json)

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

Get-Taxonomy für UIP-IXP-Projekte

Exportieren Sie das unbearbeitete IXP-Taxonomie-Artefakt des Projekts (Datentypen + Feldgruppen). Dies ist ein IXP-internes Format, das für den erneuten Import in ein anderes Projekt (import-taxonomy) vorgesehen ist, nicht für eine kuratierte, visuell lesbare Ansicht.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Beispiel

uip ixp projects get-taxonomy my-invoices --output json

Datenform (--output json)

{
  "Code": "IxpProjectsGetTaxonomy",
  "Data": {
    "status": "ok",
    "dataset": { "entity_defs": [], "label_groups": [] }
  }
}

Data wird verbatim in der eigenen schlimm_Case des Upstream-Datasets weitergeleitet, nicht in PascalCase.

UIP-IXP-Projekte Import-Taxonomie

Importieren Sie eine Taxonomie aus einer lokalen JSON-Datei in ein vorhandenes Projekt. Akzeptiert zwei Dateiformate: { field_types, label_group } (die Form, die get-taxonomy/taxonomie-vorschlag erzeugt) oder { entity_defs, label_groups } (die Form, die der Taxonomie-Endpunkt selbst zurückgibt) – entity_defs/der erste label_groups -Eintrag werden unverändert übergeben wenn das zweite Format angegeben wird, um Eigenschaften wie inherits_from von der API beizubehalten.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.
<file>	ja	Pfad zur Taxonomie-JSON-Datei.

Beispiel

uip ixp projects import-taxonomy my-invoices ./taxonomy.json

Datenform (--output json)

{
  "Code": "IxpProjectsImportTaxonomy",
  "Data": {
    "ProjectName": "my-invoices",
    "FieldTypes": 4,
    "LabelDefs": 1,
    "Labels": ["Invoice"]
  }
}

Schlägt mit einem expliziten Fehler fehl, wenn die Datei keine erkannte Form hat (sowohl field_types als auch label_group nach der Normalisierung fehlen).

UIP-IXP-Projekte konfigurieren-modell

Konfigurieren Sie die Einstellungen des Extraktionsmodells für ein Projekt. Der Proxy liest die aktuelle Konfiguration, führt sie im bereitgestellten Modell/der bereitgestellten Vorverarbeitung zusammen, schreibt sie zurück und gibt die zusammengeführte Konfiguration zurück.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Long	Wert	Beschreibung
--model <version>	string	Name des Extraktionsmodells, serverseitig validiert (z. B gemini_2_5_flash, gemini_2_5_pro, gpt_4o_2024_05_13).
--preprocessing <type>	none|table_mini|table	Intelligenter Vorverarbeitungsmodus.

Mindestens eines von --model/--preprocessing ist erforderlich – das Übergeben von beides schlägt auf der Clientseite vor jedem Aufruf fehl („Nothing“ zum Konfigurieren).

Beispiel

uip ixp projects configure-model my-invoices --model gemini_2_5_pro --preprocessing table

Datenform (--output json)

{
  "Code": "IxpProjectsConfigureModel",
  "Data": { "ProjectName": "my-invoices", "Config": {} }
}

Get-Metrics für UIP-IXP-Projekte

Rufen Sie Validierungsmetriken für ein IXP-Projekt ab.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Short	Long	Wert	Standard	Beschreibung
-m	--model-version <version>	Integer oder latest	latest	Modellversion, für die Metriken abgerufen werden sollen.

Beispiele

uip ixp projects get-metrics my-invoices --output json

uip ixp projects get-metrics my-invoices --model-version 32 --output json

Datenform (--output json)

{
  "Code": "IxpProjectsGetMetrics",
  "Data": {
    "ModelVersion": 35,
    "ValidatedDocuments": 8,
    "ProjectScore": 0.8662574291229248,
    "ProjectScoreQuality": "excellent",
    "FieldGroups": [
      { "FieldGroup": "Invoice", "F1": 0.8939051628112793, "Precision": 0.824999988079071, "Recall": 0.9753694534301758, "ErrorRate": 0.1621621549129486, "Documents": 8 }
    ],
    "Fields": [
      { "FieldGroup": "Invoice", "FieldId": "1e8eadeac608df18", "Name": "Invoice Number", "F1": 0.875, "Precision": 0.875, "Recall": 0.875, "ErrorRate": 0.125, "Documents": 8, "Annotations": 8, "Quality": "good" }
    ]
  }
}

Ein Modell, das vorhanden ist, aber noch nicht validiert wurde, gibt { "Metrics": null } anstelle der obigen einfachen Form zurück.

UIP-IXP-Projekte veröffentlichen

Veröffentlichen Sie eine Modellversion und markieren Sie sie optional mit live oder staging.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Short	Long	Wert	Beschreibung
-m	--model-version <version>	Integer	Zu veröffentlichende Modellversion. Standardmäßig wird die neueste (höchste) trainierte Version verwendet.
–	--tag <live|staging>	live|staging	Optional die veröffentlichte Version mit Tags versehen.
-d	--description <text>	string	Beschreibung für die veröffentlichte Version. Eine leere Zeichenfolge löscht eine vorhandene.

Beispiele

uip ixp projects publish my-invoices --model-version 4 --tag live --description "Q2 release"

uip ixp projects publish my-invoices --model-version 4

# --model-version defaults to the latest trained version
uip ixp projects publish my-invoices

Datenform (--output json)

{
  "Code": "IxpProjectsPublish",
  "Data": {
    "ProjectName": "my-invoices",
    "ModelVersion": 4,
    "Pinned": true,
    "Tag": { "Name": "live", "Version": 4, "UpdatedAt": "2026-04-29T00:00:00Z" },
    "Description": "Q2 release"
  }
}

Tag ist null, wenn --tag weggelassen wurde.

Die Veröffentlichung von UIP-IXP-Projekten wird aufgehoben

Die Veröffentlichung einer Modellversion aufheben. Die Version bleibt trainiert und auflistebar; Sie wird nur aus dem veröffentlichten Set entfernt.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Short	Long	Wert	Erforderlich	Beschreibung
-m	--model-version <version>	nicht negativer Integer	ja	Modellversion, deren Veröffentlichung aufgehoben werden soll.

Beispiel

uip ixp projects unpublish my-invoices --model-version 4

Datenform (--output json)

{
  "Code": "IxpProjectsUnpublish",
  "Data": { "ProjectName": "my-invoices", "ModelVersion": 4, "Pinned": false }
}

UIP-IXP-Projekte unTag

Entfernen Sie ein Tag anhand des Namens von einer Modellversion. Tag-Namen sind innerhalb eines Projekts eindeutig, auch wenn eine Version mehrere Tags enthält. Die Version bleibt trainiert und veröffentlicht; nur der Tag-Zeiger wird gelöscht.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Long	Wert	Erforderlich	Beschreibung
--tag <live|staging>	live|staging	ja	Zu entfernendes Tag nach Name.

Beispiel

uip ixp projects untag my-invoices --tag live

Datenform (--output json)

{
  "Code": "IxpProjectsUntag",
  "Data": { "ProjectName": "my-invoices", "ModelVersion": 4, "RemovedTags": ["live"] }
}

Listenmodelle für UIP-IXP-Projekte

Listen Sie alle Modellversionen und Tags für ein Projekt auf.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Beispiel

uip ixp projects list-models my-invoices

Datenform (--output json)

{
  "Code": "IxpProjectsListModels",
  "Data": { "Models": [], "Tags": [], "MaxPublished": 5 }
}

UIP-IXP-Projekte erstellen

Erstellen Sie ein IXP-Projekt. Lädt bei einem angegebenen Ordner mit Dokumenten diese hoch und schlägt eine Taxonomie aus bis zu 8 Dokumenten mit gleichmäßigen Stichproben vor; ohne Ordner wird ein leeres Projekt erstellt.

Argumente

Name	Erforderlich	Zweck
<name>	ja	Projektname.
[folder-path]	nein	Pfad zu einem Ordner von Dokumenten. Verlassen Sie das Erstellen eines leeren Projekts – ohne Dokumente ist kein Hochladen, kein Taxonomievorschlag möglich.

Optionen

Short	Long	Beschreibung
-d	--description <text>	Beschreibung dessen, was aus den Dokumenten extrahiert werden soll – wird als Kontext für den Taxonomievorschlag verwendet.
–	--skip-taxonomy	Erstellen Sie das Projekt und laden Sie Dokumente hoch, ohne eine Taxonomie vorzuschlagen.

Uploads werden bei einzelnen Dateifehlern fortgesetzt (jeder Fehler wird gesammelt, nicht schwerwiegend) – Der Befehl schlägt nur sofort fehl, wenn jeder Upload im Ordner fehlschlägt. Der Taxonomievorschlag wird bis zu 3 Mal mit einer Verzögerung von 5 Sekunden wiederholt (das Back-End kann zeitweise 500 Zeichen ausführen, während OCR noch nicht für eine PDF-Datei bereit ist); Wenn alle drei Versuche fehlschlagen, werden das Projekt und seine Dokumente trotzdem erstellt – der Fehler benennt den genauen import-taxonomy -Befehl, der danach ausgeführt werden soll.

Beispiele

uip ixp projects create "My Invoices" ./training-set --description "extract invoice header fields"

uip ixp projects create "My Invoices" ./training-set --skip-taxonomy

uip ixp projects create "My Invoices"

Datenform (--output json)

{
  "Code": "IxpProjectsCreate",
  "Data": {
    "ProjectName": "my_invoices-a1b2c3d4-ixp",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my_invoices-a1b2c3d4-ixp/my_invoices-a1b2c3d4",
    "DocumentsUploaded": 12,
    "DocumentsFailed": 0
  }
}

FailedFiles (ein Array von {file, error}) ist nur vorhanden, wenn mindestens ein Upload fehlgeschlagen ist. Wenn der Taxonomievorschlag erfolgreich ist, wird SuggestedTaxonomy mit FieldTypes (Name/Titel-Paare) und LabelGroup (Name plus LabelDefs) hinzugefügt. Wenn --skip-taxonomy übergeben wurde, wird stattdessen TaxonomySkipped: true hinzugefügt. <name> wird geslugifiziert und mit einer zufälligen ID und -ixp angehängt – es ist nicht die Literal-Zeichenfolge, die Sie übergeben haben.

Zugehörig

• uip IXP – Konzepte und das vollständige Ressourcenverzeichnis.
• uipath IXP Taxonomy – Bearbeiten Sie Datentypen, Gruppen und Felder einzeln (vs. die gesamte Taxonomie dieser Seite get-taxonomy/import-taxonomy).
• UIP IXP-Dokumente und -Beschriftungen – Laden Sie Dokumente hoch und überprüfen Sie Vorhersagen.
• UIP IXP-Bereitstellungen – stellen eine veröffentlichte Modellversion in Orchestrator bereit.

Siehe auch

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