documents uip IXP et amp; labellisations

Syntaxe et options pour « documents uip IXP » et « étiquetages IXP », qui gèrent les documents d'entraînement et examinent/confirment les prédictions du modèle relatives à ces documents.

uip ixp documents gère les documents d'entraînement bruts d'un projet (téléchargement/téléchargement/suppression/liste). uip ixp labellings examine et confirme les prédictions du modèle sur ces documents - l'étape d'intervention humaine qui produit la vérité du terrain pour la reformation. Voir Concepts sur la page parente pour savoir comment cela s'intègre dans la boucle d'entraînement.

Synthèse

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]

documents uip IXP

Lisez le contenu du document IXP.

liste des documents uip IXP

Répertorie tous les documents d'un projet.

Arguments

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

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.

Exemples

uip ixp documents list my-invoices

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

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

Téléchargement de documents uip IXP

Téléchargez le fichier du document d’origine (PDF/PNG/JPG/etc.) pour consultation. L'extension du fichier est corrigée automatiquement pour correspondre au type de contenu réel indiqué par le serveur; elle ne fait pas confiance à l'extension de --output.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
<document-id>	oui	ID de document.

Options

Short	Long	Valeur (Value)	Default	Description
-o	--output <path>	Chemin d'accès	un chemin d'accès tmpir généré	Chemin du fichier de sortie. L’extension est corrigée automatiquement (par exemple .jpeg/.tiff sont acceptés comme équivalents à .jpg/.tif, sinon une extension non correspondante ou manquante est remplacée/ajoutée).

Exemple

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

Format des données (--sortie json)

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

chargement de documents uip IXP

Chargez un fichier de document dans un projet existant. Rejete les extensions de fichier non prises en charge côté client avant tout appel réseau.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
<file>	oui	Chemin du fichier document à télécharger.

Exemple

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

Format des données (--sortie json)

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

suppression de documents uip IXP

Supprimez un document d'un projet.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
<document-id>	oui	ID de document.

Options

Short	Long	Requis	Description
-y	--yes	oui	Confirmez cette opération irréversible.

Exemple

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

Format des données (--sortie json)

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

labellisations uip IXP

Gérer les labellisations et les prédictions IXP — l'étape d'examen humain qui transforme les prédictions du modèle en une vérité du terrain confirmée.

Remarque :

confirm et get-predictions acceptent un [document-id] facultatif — son absence applique l'opération sur tous les documents du projet. Ce formulaire à l’échelle du projet est obsolète et sera supprimé dans une version future; une ligne [WARN] est écrite dans stderr lorsque vous l'omettez (stdout reste analysable pour le script --output json ). Transmettez un ID de document, trouvé via uip ixp documents list.

Groupes de champs répétables: occurrences de ciblage

Pour un groupe de champs répétable (par exemple « Lignes d’éléments» avec une occurrence par ligne de facture), confirm et unconfirm partagent un modèle de ciblage commun via --group:

Indicateur	Effet
--group <name> Seul	Cible chaque occurrence du groupe.
--group <name> --occurrence <n>	Cible exactement une occurrence (index basé sur 0) — le formulaire convivial à une seule ligne. Nécessite --group et un ID de document.
--group <name> --updates <json>	Cible plusieurs occurrences spécifiques dans un même appel: [{"occurrence":<n>,"fields"?:[...],"corrections"?:{...}}] (confirmation) ou [{"occurrence":<n>,"fields"?:[...]}] (non confirmée). --updates est le sur-ensemble - --occurrence <n> est équivalent à un --updates à entrée unique. mutuellement exclusif avec --occurrence, --fields et (pour confirm) --corrections.

--group doit correspondre au chemin complet du libellé exactement comme indiqué dans le champ Name de la sortie get-predictions (par ex. "Invoice > Line Items"), et pas seulement le nom de la feuille.

confirmation des labellisations uip IXP

Confirmez les prédictions générées par IXP comme vérité de base pour un document.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
[document-id]	non	ID de document. Son absence confirme chaque document dans le projet — obsolète.

Options

Short	Long	Valeur (Value)	Description
-f	--fields <field-ids>	Séparé par des virgules	ID de champ à confirmer. Omettez pour confirmer tous les champs prévus. Sans --group, confirme chaque ID de champ à chaque occurrence où il apparaît; avec --group --occurrence, confirme uniquement dans cette occurrence.
-c	--corrections <json>	Tableau JSON	Remplacer les valeurs prédites tout en conservant les références: [{"field_id":"...","value":"corrected"}]. S’applique à chaque occurrence dans laquelle le champ apparaît (ou à l’occurrence ciblée). Capture mutuellement exclusive avec --updates.
—	--group <name>	string	Groupe de champs cible - voir la table de ciblage ci-dessus.
—	--occurrence <index>	Integer	Index à occurrence unique dans --group. Voir la table de ciblage ci-dessus.
—	--updates <json>	Tableau JSON	Formulaire à occurrences multiples regroupé. Voir la table de ciblage ci-dessus.
-m	--model-version <version>	entier non négatif	Garde-fou de conformité optimistique: la version du modèle (de get-predictions « ModelVersion) par rapport à laquelle les prédictions ont été examinées. Si un réentraînement a produit une version plus récente depuis, la confirmation est rejetée plutôt que d'horodater les valeurs dérivées comme vérité du terrain. Omettez pour ignorer la vérification.

Exemples

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

Format des données (--sortie json)

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

TotalDocuments/PredictionsConfirmed compte documents, pas champs (PredictionsConfirmed est de 0 ou 1 par document — cela préserve le contrat par document de la CLI héritée même si le nombre de champs sous-jacents peut être plus élevé).

labellisations uip IXP ne sont pas confirmées

Supprimez les confirmations d’un document - les champs ciblés retournent à l’état non annoté. Utilisez pour restaurer une confirm/mark-missing erronée. Toutes les autres annotations du document sont reportées. Partage le modèle de ciblage --group/--occurrence/--updates de confirm (voir le tableau ci-dessus), moins --corrections/--model-version.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
<document-id>	oui	ID de document.

Options

Short	Long	Valeur (Value)	Description
-f	--fields <field-ids>	Séparé par des virgules	ID de champ à annuler.
—	--group <name>	string	Groupe de champs cible.
—	--occurrence <index>	Integer	Index à occurrence unique.
—	--updates <json>	Tableau JSON	Formulaire à occurrences multiples regroupé: [{"occurrence":<n>,"fields"?:[...]}].

Au moins une des propriétés --fields/--group est requise, il n’est pas possible de confirmer implicitement un document entier.

Exemples

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"

Format des données (--sortie json)

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

labellisations uip IXP marque-manquante

Marquer les champs comme manquants dans un document — annoté comme n’ayant pas de valeur et d’emplacement. À utiliser lorsque le champ est réellement absent.

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
<document-id>	oui	ID de document.

Options

Short	Long	Valeur (Value)	Requis	Description
-f	--fields <field-ids>	Séparé par des virgules	oui	ID de champ à marquer comme manquants.

Exemple

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

Format des données (--sortie json)

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

labellisations uip IXP get-predictions

Obtenez les prédictions du modèle Extraction et traitement intelligents (IXP) pour les documents d’un projet — les étiquettes et les valeurs de champ prédites, plus le ModelVersion qui les a produites (null lorsqu’un document n’a pas encore de prédictions).

Arguments

Nom	Requis	Objectif
<project-name>	oui	Nom du projet.
[document-id]	non	ID de document. L'omettre se déploie sur chaque document du projet — obsolète.

Exemples

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

Format des données (--sortie json)

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

Les entrées Predictions préservent la PascalCase native de l'API, y compris un index Occurrence par libellé pour les groupes répétables.

Associé

• uip IXP — concepts et le répertoire complet des ressources.
• projets uip IXP — get-metrics pour vérifier la qualité de la labellisation; publish pour expédier un modèle réentraîné.
• taxonomie uip IXP — les prédictions de champs/groupes sont ici notées.

Voir également

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