taxonomie uip IXP — champs, groupes, types de données

Syntaxe et options pour `uip IXP Fields`, `uip IXP processes` et `uip IXP data-types`, qui permettent de modifier la taxonomie d'extraction d'un projet un élément à la fois.

Trois groupes de commandes modifient la taxonomie d'un projet de manière incrémentielle: uip ixp data-types (entity_defs — définitions de type réutilisables), uip ixp groups (label_defs — conteneurs de groupe de champs) et uip ixp fields (les valeurs nommées individuelles dans un groupe). Voir Concepts sur la page parente pour la façon dont ces trois sont liés, et projects get-taxonomy/import-taxonomy pour déplacer la taxonomie entière sous forme d'un seul artefact à la place.

Le Data de chaque verbe est la réponse textuelle de l'API IXP transmise, préservant ainsi la casse native de sa clé.

Synthèse

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>

Types de données uip IXP

Gérer les types de données (entity_defs): les champs de définitions de types réutilisables sont référencés par nom.

ajout de types de données uip IXP

Créez un nouveau type de données dans le projet.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom du type de données.
--kind <kind>	text|date|money|number|boolean|choice	oui	Type de type de données sous-jacent.
--instructions <text>	string	oui	Ce que ce type représente et où ses valeurs apparaissent.
--input-value <mode>	exact-match|inferred	Conditionnel	Requis lorsque --kind est text ou choice; interdit pour date/money/number/boolean (ces types n’ont pas de propriété de ce type, correspondant à la visibilité radio de l’interface utilisateur IXP). Indique si la valeur apparaît mot pour mot dans le document, ou bien est déduite/calculée.
--choices <json>	Tableau JSON	Conditionnel	Requis lorsque --kind choice: [{"value":"<canonical>","alternates":["<alt1>",...]}]. value est le nom complet canonique (sortie du modèle); alternates (facultatif) sont d'autres orthographies que le modèle correspond à value.

Exemples

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"}]'

Format des données (--sortie json)

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

instructions de mise à jour des types de données uip IXP

Remplacez les instructions par un type de données existant.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom du type de données.
--instructions <text>	string	oui	Nouvelles instructions (remplace la valeur existante).

Exemple

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

Format des données (--sortie json)

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

Renommage des types de données uip IXP

Renommez un type de données. Les références de champ existantes restent intactes.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom du type de données actuel.
--new-name <name>	string	oui	Nouveau nom de type de données.

Exemple

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

Format des données (--sortie json)

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

suppression des types de données uip IXP

Supprimez un type de données. Impossible: tout champ y faisant référence via field_type_id sera interrompu.

Options

Short	Long	Valeur (Value)	Requis	Description
—	--name <name>	string	oui	Nom du type de données à supprimer.
-y	--yes	Drapeau	oui	Confirmez cette opération irréversible.

Exemple

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

Format des données (--sortie json)

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

groupes uip IXP

Gérer les groupes de champs (label_defs): les conteneurs de type document pour les champs.

ajout de groupes uip IXP

Créez un nouveau groupe de champs avec des instructions et au moins un champ.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nouveau nom de groupe de champs.
--instructions <text>	string	oui	Le type de document/section que couvre le groupe.
--fields <json>	Tableau JSON	oui	Au moins un champ: [{"name":"...","type":"<data-type-name>","instructions":"..."}]. type est le nom d'un type de données (entity_def) dans la taxonomie du projet — résolu et validé côté serveur.

Exemple

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."}]'

Format des données (--sortie json)

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

suppression de groupes uip IXP

Supprimez un groupe de champs. Impossible: toutes les annotations de tous les champs du groupe sont supprimées.

Options

Short	Long	Valeur (Value)	Requis	Description
—	--name <name>	string	oui	Nom du groupe de champs à supprimer.
-y	--yes	Drapeau	oui	Confirmez cette opération irréversible.

Exemple

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

Format des données (--sortie json)

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

uip IXP groups changement de nom

Renommez un groupe de champs. Préserve tous les champs et annotations.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom actuel du groupe de champs.
--new-name <name>	string	oui	Nouveau nom de groupe de champs.

Exemple

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

Format des données (--sortie json)

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

Groupes UIP IXP - Invites de mise à jour

Instructions d'extraction de groupe de champs de mise à jour groupée, correspondantes par nom de groupe. Les champs existants sont conservés.

Options

Long	Valeur (Value)	Requis	Description
--updates <json>	Tableau JSON	oui	[{"name":"<group>","instructions":"..."}]. Correspondant par label_def nom - les noms non correspondants sont signalés, pas d'erreur.

Exemple

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

Format des données (--sortie json)

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

champs uip IXP

Modifier les champs dans les groupes de champs d'un projet (label_defs).

ajouter des champs uip IXP

Ajoutez un nouveau champ à un groupe de champs.

Options

Long	Valeur (Value)	Requis	Description
--group <name>	string	oui	Nom du groupe de champs (label_def).
--field <name>	string	oui	Nouveau nom de champ.
--type <type-name>	string	oui	Type de champ — nom d'un type de données (entity_def) dans la taxonomie du projet.
--instructions <text>	string	oui	Éléments à extraire et où les trouver.

Exemple

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

Format des données (--sortie json)

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

suppression des champs uip IXP

Supprimer un champ d'un groupe de champs.

Options

Short	Long	Valeur (Value)	Requis	Description
—	--group <name>	string	oui	Nom du groupe de champs.
—	--field <name>	string	oui	Nom du champ à supprimer.
-y	--yes	Drapeau	oui	Confirmez cette opération irréversible.

Exemple

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

Format des données (--sortie json)

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

changement de nom des champs uip IXP

Renommez un champ dans un groupe de champs.

Options

Long	Valeur (Value)	Requis	Description
--group <name>	string	oui	Nom du groupe de champs.
--field <name>	string	oui	Nom du champ actuel.
--new-name <name>	string	oui	Nouveau nom de champ.

Exemple

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

Format des données (--sortie json)

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

UIP IXP Types de modification de champs

Modifier le type d'un champ. Impossible: les annotations existantes de ce champ sont supprimées.

Options

Short	Long	Valeur (Value)	Requis	Description
—	--group <name>	string	oui	Nom du groupe de champs.
—	--field <name>	string	oui	Nom du champ.
—	--type <type-name>	string	oui	Nouveau type de champ — nom d'un type de données dans la taxonomie du projet.
-y	--yes	Drapeau	oui	Confirmez cette opération irréversible (supprime les annotations du champ).

Exemple

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

Format des données (--sortie json)

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

champs uip IXP update-invites

Mise à jour groupée des instructions d'extraction par champ, correspondante par nom de champ dans tous les groupes de champs. Les définitions de champs existantes sont conservées.

Options

Long	Valeur (Value)	Requis	Description
--updates <json>	Tableau JSON	oui	[{"name":"<field>","instructions":"..."}]. Correspondance par nom de champ.

Exemple

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"}]'

Format des données (--sortie json)

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

Associé

• uip IXP — concepts et le répertoire complet des ressources.
• projets uip IXP — get-taxonomy/import-taxonomy pour déplacer l'ensemble de la taxonomie en un seul artefact.
• uip IXP documents & labels - les champs/groupes définis ici sont prédits et confirmés.

Voir également

• Présentation de l’outil IXP
• Options globales
• Codes de sortie