documentos uip ixp & Etiquetados

Sintaxis y opciones para "documentos ixp de uip" y "etiquetados ixp de uip", que gestionan los documentos de entrenamiento y revisan/confirman las predicciones del modelo sobre ellos.

uip ixp documents gestiona los documentos de entrenamiento sin procesar de un proyecto (cargar/descargar/eliminar/enumerar). uip ixp labellings revisa y confirma las predicciones del modelo en esos documentos: el paso humano en el bucle que produce datos reales para el reentrenamiento. Consulta Conceptos en la página principal para ver cómo encaja esto en el bucle de entrenamiento.

Sinopsis

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]

Documentos ixp de uip

Leer el contenido del documento de Extracción y Procesamiento Inteligentes (IXP).

lista de documentos ixp de uip

Enumerar todos los documentos de un proyecto.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-l	--limit <number>	1-10 000	50	Número de elementos que se van a devolver.
—	--offset <number>	0-1000000	0	Número de elementos que omitir.

Ejemplos

uip ixp documents list my-invoices

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

Forma de datos (--json de salida)

{
  "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
  }
}

descarga de documentos ixp de uip

Descarga el archivo del documento original (PDF/PNG/JPG/etc.) para ver. La extensión del archivo se corrige automáticamente para que coincida con el tipo de contenido real que informa el servidor: no confía en la extensión de --output.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.
<document-id>	Sí	ID del documento.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-o	--output <path>	Ruta	una ruta tmpdir generada	Ruta del archivo de salida. La extensión se corrige automáticamente (p. ej. .jpeg/.tiff se aceptan como equivalentes a .jpg/.tif; de lo contrario, se reemplaza/anexa una extensión que no coincide o que falta.

Ejemplo

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

Forma de datos (--json de salida)

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

Carga de documentos UIP IXP

Cargar un archivo de documento a un proyecto existente. Rechaza las extensiones de archivo no compatibles en el lado del cliente antes de cualquier llamada de red.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.
<file>	Sí	Ruta al archivo del documento que se va a cargar.

Ejemplo

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

Forma de datos (--json de salida)

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

eliminación de documentos ixp de uip

Eliminar un documento de un proyecto.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.
<document-id>	Sí	ID del documento.

Opciones

Corto	Largo	Obligatorio	Descripción
-y	--yes	Sí	Confirme esta operación irreversible.

Ejemplo

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

Forma de datos (--json de salida)

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

etiquetados ixp de uip

Gestionar etiquetados y predicciones de Extracción y Procesamiento Inteligentes (IXP): el paso de revisión humana que convierte las predicciones del modelo en datos reales confirmados.

Nota:

confirm y get-predictions aceptan un [document-id] opcional : omitirlo aplica la operación en todos los documentos del proyecto. Este formulario para todo el proyecto está obsoleto y se eliminará en una versión futura; se escribe una línea [WARN] en stderr cuando se omite (stdout sigue siendo analizable para el scripting --output json ). Pase un ID de documento, encontrado a través de uip ixp documents list.

Grupos de campos repetibles: ocurrencias de destino

Para un grupo de campos repetible (por ejemplo "Elementos de línea" con una ocurrencia por línea de factura), confirm y unconfirm comparten un modelo de orientación común a través de --group:

Banderas	Efecto
--group <name> solo	Apunta a cada repetición del grupo.
--group <name> --occurrence <n>	Se dirige exactamente a una ocurrencia (índice basado en 0): la forma ergonómica de una sola línea. Requiere --group y un ID de documento.
--group <name> --updates <json>	Se dirige a varias ocurrencias específicas en una llamada atómica: [{"occurrence":<n>,"fields"?:[...],"corrections"?:{...}}] (confirmar) o [{"occurrence":<n>,"fields"?:[...]}] (no confirmar). --updates es el superconjunto: --occurrence <n> es equivalente a un --updates de entrada única. Mutuamente exclusivo con --occurrence, --fields, y (para confirm) --corrections.

--group debe ser la ruta completa de la etiqueta exactamente como se muestra en el campo Name de la salida get-predictions (por ejemplo "Invoice > Line Items"), no solo el nombre de la hoja.

confirmación de etiquetado ixp de uip

Confirma las predicciones generadas por Extracción y Procesamiento Inteligentes (IXP) como datos reales para un documento.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.
[document-id]	No	ID del documento. Omitirlo confirma todos los documentos del proyecto: obsoleto.

Opciones

Corto	Largo	Valor	Descripción
-f	--fields <field-ids>	separados por comas	ID de campo para confirmar. Omitir para confirmar todos los campos previstos. Sin --group, confirma cada ID de campo en cada aparición en la que aparece; con --group --occurrence, confirma solo dentro de esa repetición.
-c	--corrections <json>	MatrizJson	Anular los valores predichos manteniendo las referencias: [{"field_id":"...","value":"corrected"}]. Se aplica a todas las ocurrencias en las que aparece el campo (o la ocurrencia de destino). Mutuamente exclusivo con --updates.
—	--group <name>	String	Grupo de campos de destino: consulta la tabla de destino anterior.
—	--occurrence <index>	Entero	Índice de ocurrencia única dentro de --group. Consulte la tabla de orientación anterior.
—	--updates <json>	MatrizJson	Formulario de varias ocurrencias por lotes. Consulte la tabla de orientación anterior.
-m	--model-version <version>	entero no negativo	Protección de concurrencia optimista: la versión del modelo (de get-predictions' ModelVersion) contra la que se revisaron las predicciones. Si un reentrenamiento produjo una versión más reciente desde entonces, la confirmación se rechaza en lugar de sellar los valores desviados como datos reales. Omitir para omitir la comprobación.

Ejemplos

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

Forma de datos (--json de salida)

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

TotalDocuments/PredictionsConfirmed cuenta documentos, no campos (PredictionsConfirmed es 0 o 1 por documento; esto conserva el contrato por documento de la CLI heredada aunque el recuento de campos subyacente pueda ser mayor).

no confirmar los etiquetados ixp de uip

Eliminar confirmaciones de un documento: los campos de destino vuelven a estar sin anotar. Utilízalo para revertir un confirm/mark-missing erróneo. Cada dos anotaciones en el documento se trasladan. Comparte el modelo de orientación --group/--occurrence/--updates de confirm (consulte la tabla anterior), menos --corrections/--model-version.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.
<document-id>	Sí	ID del documento.

Opciones

Corto	Largo	Valor	Descripción
-f	--fields <field-ids>	separados por comas	ID de campo para no confirmar.
—	--group <name>	String	Grupo de campos de destino.
—	--occurrence <index>	Entero	Índice de ocurrencia única.
—	--updates <json>	MatrizJson	Formulario de varias ocurrencias por lotes: [{"occurrence":<n>,"fields"?:[...]}].

Se requiere al menos uno de --fields/--group: no se permite desconfirmar implícitamente un documento completo.

Ejemplos

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"

Forma de datos (--json de salida)

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

Falta la marca de los etiquetados ixp de uip

Marcar campos como faltantes en un documento: anotados como sin valor y sin ubicación. Utilízalo cuando el campo esté realmente ausente.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.
<document-id>	Sí	ID del documento.

Opciones

Corto	Largo	Valor	Obligatorio	Descripción
-f	--fields <field-ids>	separados por comas	Sí	ID de campo para marcar como faltantes.

Ejemplo

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

Forma de datos (--json de salida)

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

uip ixp labellings get-predictions

Obtener predicciones del modelo de Extracción y Procesamiento Inteligentes (IXP) para los documentos de un proyecto: etiquetas y valores de campo predichos, más los ModelVersion que los produjeron (null cuando un documento aún no tiene predicciones).

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.
[document-id]	No	ID del documento. Omitirlo se extiende por todos los documentos del proyecto: obsoleto.

Ejemplos

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

Forma de datos (--json de salida)

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

Las entradas Predictions conservan el PascalCase nativo de la API, incluido un índice Occurrence por etiqueta para grupos repetibles.

Relacionado

• uip ixp : conceptos y el directorio de recursos completo.
• proyectos ixp de uip : get-metrics para comprobar la calidad del etiquetado; publish para enviar un modelo reentrenado.
• Taxonomía de uip ixp : las predicciones de campos/grupos aquí se puntúan en función de.

Ver también

• Descripción general de la herramienta IXP
• Opciones globales
• Códigos de salida