projets uip IXP

Syntaxe et options pour `uip IXP projects`, qui crée et gère des projets d'entraînement Extraction et traitement intelligents — publication de modèles, mesures et importation/exportation de taxonomie.

uip ixp projects crée et gère des projets d'entraînement IXP: le conteneur de niveau supérieur pour une taxonomie, des documents d'entraînement et des versions de modèle entraînées. Voir Concepts sur la page parente pour la vue d'ensemble du modèle de taxonomie et de la boucle d'entraînement.

Synthèse

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]

liste des projets uip IXP

Répertoriez tous les projets de formation IXP dans le locataire.

Options

Short	Long	Valeur (Value)	Default	Description
-l	--limit <number>	1-10 000	50	Nombre d'éléments à renvoyer.
—	--offset <number>	0-1000000	0	Nombre d'éléments à ignorer.

Exemple

uip ixp projects list

Format des données (--sortie 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
  }
}

La réponse entière, y compris Data, est transmise à partir de l'API IXP verbatim — les clés conservent leur PascalCase natif ici, mais voir la note de chaque autre verbe sur la casse, car elle varie par point de terminaison.

Obtenir des projets uip IXP

Obtenez un projet d'entraînement IXP par nom.

Arguments

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

Exemple

uip ixp projects get my-invoices

Format des données (--sortie 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"
  }
}

suppression de projets uip IXP

Supprimer définitivement un projet - ses documents, sa taxonomie et ses modèles entraînés. Impossible; nécessite --yes.

Arguments

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

Options

Short	Long	Description
-y	--yes	Confirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemple

uip ixp projects delete my-invoices --yes

Format des données (--sortie json)

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

Titre des projets uip IXP

Mettez à jour le titre d'affichage d'un projet. Le proxy synchronise les titres de l’ensemble de données et du projet côté serveur.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
<new-title>	oui	Nouveau titre d'affichage.

Exemple

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

Format des données (--sortie 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"
  }
}

invite de mise à jour des projets uip IXP

Mettez à jour les instructions d'extraction globales du projet - l'invite à l'échelle de la taxonomie donnant le contexte du modèle pertinent pour chaque groupe de champs. Correspond aux « Instructions d’extraction globales » de l’interface utilisateur IXP sur la page Gérer la taxonomie. Distinctif de la propre invite d'un groupe de champs (taxonomy groups update-prompts) et des invites par champ (taxonomy fields update-prompts).

Arguments

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

Options

Long	Valeur (Value)	Requis	Description
--prompt <text>	string	oui	Nouvelles instructions générales d'extraction. Remplace la valeur existante.

Exemple

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

Format des données (--sortie json)

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

projets uip IXP

Exportez l'artefact de taxonomie IXP brut du projet (types de données + groupes de champs). Il s’agit d’un format interne IXP destiné à être réimporté dans un autre projet (import-taxonomy), et non une vue sélectionnée et lisible par un humain.

Arguments

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

Exemple

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

Format des données (--sortie json)

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

Data est transmis textuellement dans le propre Guide.

projets uip IXP import-terme de taxonomie

Importez un (terme) de taxonomie depuis un fichier JSON local dans un projet existant. Accepte deux formats de fichiers: { field_types, label_group } (la forme get-taxonomy/terme du produit de la suggestion de taxonomie) ou { entity_defs, label_groups } (la forme renvoyée par le point de terminaison de la taxonomie) — entity_defs/la première entrée label_groups sont transmises telles quelles lorsqu'on indique le deuxième format, pour conserver les propriétés telles que inherits_from requises par l'API.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
<file>	oui	Chemin d’accès au fichier JSON de taxonomie.

Exemple

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

Format des données (--sortie json)

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

Échoue avec une erreur explicite si le fichier n’a aucune forme reconnue (manquant à la fois field_types et label_group après la normalisation).

projets uip IXP configure-model

Configurez les paramètres du modèle d'extraction pour un projet. Le proxy lit la configuration actuelle, fusionne dans le modèle/prétraitement fourni, l’écrit à nouveau et renvoie la configuration fusionnée.

Arguments

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

Options

Long	Valeur (Value)	Description
--model <version>	string	Nom du modèle d'extraction, validé côté serveur (par exemple gemini_2_5_flash, gemini_2_5_pro, gpt_4o_2024_05_13).
--preprocessing <type>	none|table_mini|table	Mode de prétraitement intelligent.

Au moins une de --model/--preprocessing est requise — la transmission n’échoue pas côté client avant tout appel (« Rien à configurer»).

Exemple

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

Format des données (--sortie json)

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

uip IXP projects get-metrics

Obtenir les mesures de validation pour un projet IXP.

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
-m	--model-version <version>	entier ou latest	latest	La version du modèle pour laquelle obtenir des mesures.

Exemples

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

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

Format des données (--sortie 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" }
    ]
  }
}

Un modèle qui existe mais qui n'a pas été validé encore renvoie { "Metrics": null } au lieu de la forme plate ci-dessus.

publication de projets uip IXP

Publiez une version de modèle, en la balisant éventuellement live ou staging.

Arguments

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

Options

Short	Long	Valeur (Value)	Description
-m	--model-version <version>	Integer	Version du modèle à publier. La valeur par défaut est la dernière version entraînée (la plus élevée).
—	--tag <live|staging>	live|staging	Vous pouvez éventuellement baliser la version publiée.
-d	--description <text>	string	Description de la version publiée. Une chaîne vide efface une fenêtre existante.

Exemples

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

Format des données (--sortie 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 est null lorsque --tag a été omis.

annulation de la publication de projets uip IXP

Annulez la publication d'une version de modèle. La version reste entraînée et listable; elle est uniquement supprimée de l'ensemble publié.

Arguments

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

Options

Short	Long	Valeur (Value)	Requis	Description
-m	--model-version <version>	entier non négatif	oui	Version du modèle à annuler la publication.

Exemple

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

Format des données (--sortie json)

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

Retirer les balises des projets UIP IXP

Supprimez une balise d'une version de modèle par nom. Les noms de balises sont uniques dans un projet, il est donc sans ambiguïté même si une version contient plusieurs balises. La version reste entraînée et publiée; seul son pointeur de balise est effacé.

Arguments

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

Options

Long	Valeur (Value)	Requis	Description
--tag <live|staging>	live|staging	oui	Balise à supprimer, par nom.

Exemple

uip ixp projects untag my-invoices --tag live

Format des données (--sortie json)

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

modèles de liste de projets uip IXP

Répertoriez toutes les versions de modèle et les balises d'un projet.

Arguments

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

Exemple

uip ixp projects list-models my-invoices

Format des données (--sortie json)

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

création de projets uip IXP

Créez un projet IXP. À partir d’un dossier de documents, les télécharge et suggère une taxonomie à partir de 8 documents échantillonnés de manière uniforme; sans dossier, crée un projet vide.

Arguments

Nom	Requis	Objectif
<name>	oui	Nom du projet.
[folder-path]	non	Chemin d’accès à un dossier de documents. Omettez de créer un projet vide — aucun téléchargement, aucune suggestion de taxonomie n’est possible sans documents.

Options

Short	Long	Description
-d	--description <text>	Description de ce qu’il faut extraire des documents — utilisée comme contexte pour la suggestion de taxonomie.
—	--skip-taxonomy	Créez le projet et chargez des documents sans suggérer de taxonomie.

Les chargements se continuent en cas d'échec de fichiers individuels (chaque échec est collecté, non fatal) — la commande n'échoue que si chaque téléchargement dans le dossier échoue. La suggestion de taxonomie se réessaie jusqu’à 3 fois avec un délai de 5 secondes (le backend peut atteindre 500 par intermittence tandis que l’OCR n’est pas encore prêt pour un PDF); si les 3 tentatives échouent, le projet et ses documents sont toujours créés — l'erreur nomme la commande import-taxonomy exacte à exécuter par la suite.

Exemples

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"

Format des données (--sortie 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 (un tableau de {file, error}) est présent uniquement lorsqu'au moins un téléchargement a échoué. Lorsque la suggestion de taxonomie a réussi, SuggestedTaxonomy est ajouté avec FieldTypes (paires nom/titre) et LabelGroup (nom plus LabelDefs). Lorsque --skip-taxonomy a été transmis, TaxonomySkipped: true est ajouté à la place. <name> est renvoyé sous forme de champ de données dynamique et suivi d'un ID aléatoire et de -ixp — il ne s'agit pas de la chaîne littérale que vous avez transmise.

Associé

• uip IXP — concepts et le répertoire complet des ressources.
• taxonomie uip IXP — modifier les types de données, les groupes et les champs un à la fois (vs la taxonomie entière de cette page get-taxonomy/import-taxonomy).
• uip IXP documents & labels : téléchargez des documents et examinez les prédictions.
• déploiements uip IXP — déployent une version publiée du modèle dans Orchestrator.

Voir également

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