UIP IXP-Taxonomie – Felder, Gruppen, Datentypen

Syntax und Optionen für „UIP IXP Fields“, „UIP IXP Groups“ und „uip IXP Data-Types“, die die Extraktionstaxonomie eines Projekts einzeln bearbeiten.

Drei Befehlsgruppen bearbeiten die Taxonomie eines Projekts schrittweise: uip ixp data-types (entity_defs – wiederverwendbare Typdefinitionen), uip ixp groups (label_defs – Feldgruppencontainer) und uip ixp fields (die einzelnen benannten Werte innerhalb einer Gruppe). Siehe Konzepte auf der übergeordneten Seite, um zu erfahren, wie diese drei zusammenhängen, und projects get-taxonomy/import-taxonomy zum Verschieben der gesamten Taxonomie als ein Artefakt.

Das Data jedes Verbs ist die weitergeleitete IXP-API-Antwort, wobei die native Groß-/Kleinschreibung des Schlüssels erhalten bleibt.

Zusammenfassung

uip ixp data-types add <project-name> --name <name> --kind <kind> --instructions <text> [--input-value <mode>] [--choices <json>]
uip ixp data-types update-instructions <project-name> --name <name> --instructions <text>
uip ixp data-types rename <project-name> --name <name> --new-name <name>
uip ixp data-types delete <project-name> --name <name> -y

uip ixp groups add <project-name> --name <name> --instructions <text> --fields <json>
uip ixp groups delete <project-name> --name <name> -y
uip ixp groups rename <project-name> --name <name> --new-name <name>
uip ixp groups update-prompts <project-name> --updates <json>

uip ixp fields add <project-name> --group <name> --field <name> --type <type> --instructions <text>
uip ixp fields delete <project-name> --group <name> --field <name> -y
uip ixp fields rename <project-name> --group <name> --field <name> --new-name <name>
uip ixp fields change-type <project-name> --group <name> --field <name> --type <type> -y
uip ixp fields update-prompts <project-name> --updates <json>

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

Datentypen verwalten (entity_defs) – die wiederverwendbaren Typdefinitionsfelder, auf die durch den Namen verwiesen wird.

UIP-IXP-Datentypen hinzufügen

Erstellen Sie einen neuen Datentyp im Projekt.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Name des Datentyps.
--kind <kind>	text|date|money|number|boolean|choice	ja	Art des zugrunde liegenden Datentyps.
--instructions <text>	string	ja	Was dieser Typ darstellt und wo seine Werte angezeigt werden.
--input-value <mode>	exact-match|inferred	bedingt	Erforderlich, wenn --kind text oder choice ist; verboten für date/money/number/boolean (diese Arten haben keine solche Eigenschaft, die mit der Radiosichtbarkeit der Intelligente Datenextraktion und Verarbeitung (IXP)-Benutzeroberfläche übereinstimmt). Ob der Wert wörtlich im Dokument erscheint oder abgeleitet/berechnet wird.
--choices <json>	JSON-Array	bedingt	Erforderlich, wenn --kind choice: [{"value":"<canonical>","alternates":["<alt1>",...]}]. value ist der kanonische Anzeigename (Modellausgabe); alternates (optional) sind weitere Schreibweisen, die das Modell value zuordnet.

Beispiele

uip ixp data-types add my-invoices --name "Email Address" --kind text \
  --instructions "An email address in the form local@domain." --input-value exact-match

# boolean kinds don't take --input-value
uip ixp data-types add my-invoices --name "Has Signature" --kind boolean \
  --instructions "True if the document has a handwritten signature."

# choice kind — alternates are optional per entry
uip ixp data-types add my-invoices --name "Citizenship" --kind choice \
  --instructions "Borrower citizenship status." --input-value exact-match \
  --choices '[{"value":"us","alternates":["U.S. Citizen","United States","USA"]},{"value":"permanent alien","alternates":["lawful permanent resident"]},{"value":"non-permanent alien"}]'

Datenform (--output json)

{
  "Code": "IxpDataTypesAdd",
  "Data": { "ProjectName": "my-invoices", "Name": "Email Address", "Kind": "text", "InputValue": "exact-match" }
}

Anweisungen zur Aktualisierung der UIP-IXP-Datentypen

Ersetzen Sie die Anweisungen durch einen vorhandenen Datentyp.

Argumente

Name	Erforderlich	Zweck
<project-name>	ja	Projektname.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Name des Datentyps.
--instructions <text>	string	ja	Neue Anweisungen (ersetzt den vorhandenen Wert).

Beispiel

uip ixp data-types update-instructions my-invoices --name "Email Address" \
  --instructions "A valid email address in the form local@domain. Reject malformed addresses."

Datenform (--output json)

{ "Code": "IxpDataTypesUpdateInstructions", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }

uip IXP data-types umbenennen

Einen Datentyp umbenennen. Vorhandene Feldreferenzen bleiben erhalten.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Name des aktuellen Datentyps.
--new-name <name>	string	ja	Neuer Name des Datentyps.

Beispiel

uip ixp data-types rename my-invoices --name "Email Address" --new-name "Email"

Datenform (--output json)

{ "Code": "IxpDataTypesRename", "Data": { "ProjectName": "my-invoices", "OldName": "Email Address", "NewName": "Email" } }

UIP-IXP-Datentypen löschen

Löschen Sie einen Datentyp. Irreversible: Jedes Feld, das über field_type_id darauf verweist, wird Break.

Optionen

Short	Long	Wert	Erforderlich	Beschreibung
–	--name <name>	string	ja	Zu löschender Datentypname.
-y	--yes	Markieren	ja	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang.

Beispiel

uip ixp data-types delete my-invoices --name "Email Address" --yes

Datenform (--output json)

{ "Code": "IxpDataTypesDelete", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }

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

Feldgruppen verwalten (label_defs) – die Dokumenttypcontainer für Felder.

UIP-IXP-Gruppen hinzufügen

Erstellen Sie eine neue Feldgruppe mit Anweisungen und mindestens einem Feld.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Neuer Feldgruppenname.
--instructions <text>	string	ja	Welche Art von Dokument/Abschnitt die Gruppe abdeckt.
--fields <json>	JSON-Array	ja	Mindestens ein Feld: [{"name":"...","type":"<data-type-name>","instructions":"..."}]. type ist der Name eines Datentyps (entity_def) in der Taxonomie des Projekts – serverseitig aufgelöst und validiert.

Beispiel

uip ixp groups add my-invoices --name Invoice --instructions "Header fields" \
  --fields '[{"name":"Invoice Number","type":"Text","instructions":"Unique invoice identifier near the top-right."},{"name":"Date","type":"Date","instructions":"Date the invoice was issued."},{"name":"Total","type":"Money","instructions":"Grand total at the bottom."}]'

Datenform (--output json)

{ "Code": "IxpGroupsAdd", "Data": { "ProjectName": "my-invoices", "Group": "Invoice", "FieldsCreated": 3 } }

UIP IXP-Gruppen löschen

Eine Feldgruppe löschen. irreversibel: Alle Anmerkungen zu allen Feldern in der Gruppe werden gelöscht.

Optionen

Short	Long	Wert	Erforderlich	Beschreibung
–	--name <name>	string	ja	Zu löschender Feldgruppenname.
-y	--yes	Markieren	ja	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang.

Beispiel

uip ixp groups delete my-invoices --name Invoice --yes

Datenform (--output json)

{ "Code": "IxpGroupsDelete", "Data": { "ProjectName": "my-invoices", "Group": "Invoice" } }

Umbenennung von IXP-Gruppen

Eine Feldgruppe umbenennen. Behält alle Felder und Anmerkungen bei.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Name der aktuellen Feldgruppe.
--new-name <name>	string	ja	Neuer Feldgruppenname.

Beispiel

uip ixp groups rename my-invoices --name Invoice --new-name InvoiceHeader

Datenform (--output json)

{ "Code": "IxpGroupsRename", "Data": { "ProjectName": "my-invoices", "OldName": "Invoice", "NewName": "InvoiceHeader" } }

IXP-Gruppen-Aktualisierungsaufforderungen

Anweisungen zur Massenaktualisierung von Feldgruppen, die dem Gruppennamen entsprechen. Vorhandene Felder werden beibehalten.

Optionen

Long	Wert	Erforderlich	Beschreibung
--updates <json>	JSON-Array	ja	[{"name":"<group>","instructions":"..."}]. Abgleich mit label_def Name – nicht übereinstimmende Namen werden gemeldet, kein Fehler.

Beispiel

uip ixp groups update-prompts my-invoices --updates '[{"name":"Invoice","instructions":"Header fields at the top of the document"}]'

Datenform (--output json)

{
  "Code": "IxpGroupsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "GroupsUpdated": 1, "Unmatched": [] }
}

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

Bearbeiten von Feldern innerhalb der Feldgruppen eines Projekts (label_defs).

UIP-Felder für Intelligente Datenextraktion und Verarbeitung (IXP) hinzufügen

Fügen Sie ein neues Feld zu einer Feldgruppe hinzu.

Optionen

Long	Wert	Erforderlich	Beschreibung
--group <name>	string	ja	Name der Feldgruppe (label_def).
--field <name>	string	ja	Neuer Feldname.
--type <type-name>	string	ja	Feldtyp – Name eines Datentyps (entity_def) in der Taxonomie des Projekts.
--instructions <text>	string	ja	Was extrahiert werden soll und wo es zu finden ist.

Beispiel

uip ixp fields add my-invoices --group Invoice --field "Due Date" --type Date \
  --instructions "Date payment is due."

Datenform (--output json)

{
  "Code": "IxpFieldsAdd",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date", "FieldTypeId": "c3f08a1b6d2e4f97" }
}

UIP-Felder für Intelligente Datenextraktion und Verarbeitung (IXP) löschen

Löschen Sie ein Feld aus einer Feldgruppe.

Optionen

Short	Long	Wert	Erforderlich	Beschreibung
–	--group <name>	string	ja	Feldgruppenname.
–	--field <name>	string	ja	Zu löschender Feldname.
-y	--yes	Markieren	ja	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang.

Beispiel

uip ixp fields delete my-invoices --group Invoice --field 'Due Date' --yes

Datenform (--output json)

{ "Code": "IxpFieldsDelete", "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date" } }

Umbenennung von UIP-IXP-Feldern

Benennen Sie ein Feld innerhalb einer Feldgruppe um.

Optionen

Long	Wert	Erforderlich	Beschreibung
--group <name>	string	ja	Feldgruppenname.
--field <name>	string	ja	Aktueller Feldname.
--new-name <name>	string	ja	Neuer Feldname.

Beispiel

uip ixp fields rename my-invoices --group Invoice --field 'Due Date' --new-name 'Payment Due'

Datenform (--output json)

{
  "Code": "IxpFieldsRename",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "OldName": "Due Date", "NewName": "Payment Due" }
}

UIP-IXP-Felder ändern den Typ

Ändern Sie den Typ eines Felds. irreversibel: Vorhandene Anmerkungen für dieses Feld werden gelöscht.

Optionen

Short	Long	Wert	Erforderlich	Beschreibung
–	--group <name>	string	ja	Feldgruppenname.
–	--field <name>	string	ja	Feldname.
–	--type <type-name>	string	ja	Neuer Feldtyp – Name eines Datentyps in der Taxonomie des Projekts.
-y	--yes	Markieren	ja	Bestätigen Sie diesen endgültigen Vorgang (löscht die Anmerkungen des Felds).

Beispiel

uip ixp fields change-type my-invoices --group Invoice --field 'Total' --type Money --yes

Datenform (--output json)

{
  "Code": "IxpFieldsChangeType",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Total", "NewFieldTypeId": "d9b1740e3a6c2f85" }
}

IXP-Felder Aktualisierungs-Prompts

Massenaktualisierung von Extraktionsanweisungen pro Feld, die dem Feldnamen für alle Feldgruppen zugeordnet sind. Vorhandene Felddefinitionen werden beibehalten.

Optionen

Long	Wert	Erforderlich	Beschreibung
--updates <json>	JSON-Array	ja	[{"name":"<field>","instructions":"..."}]. Abgleich mit dem Feldnamen.

Beispiel

uip ixp fields update-prompts my-invoices --updates '[{"name":"Invoice Number","instructions":"7-digit numeric ID at top-right"},{"name":"Total","instructions":"Grand total at the bottom"}]'

Datenform (--output json)

{
  "Code": "IxpFieldsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "FieldsUpdated": 2, "Unmatched": [] }
}

Zugehörig

• uip IXP – Konzepte und das vollständige Ressourcenverzeichnis.
• uip ixp-Projekte – get-taxonomy/import-taxonomy zum Verschieben der gesamten Taxonomie als ein Artefakt.
• UIP IXP Dokumente und Beschriftungen – Die hier definierten Felder/Gruppen werden dort vorhergesagt und bestätigt.

Siehe auch

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