UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

proyectos ixp de uip

Sintaxis y opciones para `proyectos IXP de uIP`, que crea y gestiona proyectos de entrenamiento de IXP: publicación de modelos, métricas e importación/exportación de taxonomía.

uip ixp projects crea y gestiona proyectos de entrenamiento de Extracción y Procesamiento Inteligentes (IXP): el contenedor de nivel superior para una taxonomía, documentos de entrenamiento y versiones de modelos entrenados. Consulta Conceptos en la página principal para ver el modelo de taxonomía y la descripción general del bucle de entrenamiento.

Sinopsis​

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]
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]

lista de proyectos ixp de uip​

Enumera todos los proyectos de formación de Extracción y Procesamiento Inteligentes (IXP) en el tenant.

Opciones​

CortoLargoValorPredeterminadoDescripción
-l--limit <number>1-10 00050Número de elementos que se van a devolver.
—--offset <number>0-10000000Número de elementos que omitir.

Ejemplo​

uip ixp projects list
uip ixp projects list

Forma de datos (--json de salida)​

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

Toda la respuesta, incluido Data, se reenvía desde la API de Extracción y Procesamiento Inteligentes (IXP) palabra por palabra: las claves mantienen su PascalCase nativo aquí, pero ven la nota de cada verbo en mayúsculas y minúsculas, ya que varía según el punto final.

obtención de proyectos ixp de uip​

Obtener un proyecto de formación de Extracción y Procesamiento Inteligentes (IXP) por nombre.

Argumentos​

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

Ejemplo​

uip ixp projects get my-invoices
uip ixp projects get my-invoices

Forma de datos (--json de salida)​

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

eliminar proyectos ixp de uip​

Eliminar de forma permanente un proyecto: sus documentos, taxonomía y modelos entrenados. Irreversible; requiere --yes.

Argumentos​

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

Opciones​

CortoLargoDescripción
-y--yesConfirme esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplo​

uip ixp projects delete my-invoices --yes
uip ixp projects delete my-invoices --yes

Forma de datos (--json de salida)​

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

actualización-título de proyectos ixp de UIP​

Actualizar el título de visualización de un proyecto. El proxy mantiene los títulos del conjunto de datos y del proyecto sincronizados en el lado del servidor.

Argumentos​

NombreObligatorioPropósito
<project-name>SíNombre del proyecto.
<new-title>SíNuevo título de visualización.

Ejemplo​

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

Forma de datos (--json de salida)​

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

solicitud de actualización de proyectos ixp de uip​

Actualiza las instrucciones generales de extracción del proyecto: la solicitud de toda la taxonomía que proporciona el contexto del modelo relevante en cada grupo de campos. Coincide con el mensaje "Instrucciones generales de extracción" de la IU de Extracción y Procesamiento Inteligentes (IXP) en la página Administrar taxonomía. Distinto de la solicitud propia de un grupo de campos (taxonomy groups update-prompts) y las solicitudes por campo (taxonomy fields update-prompts).

Argumentos​

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

Opciones​

LargoValorObligatorioDescripción
--prompt <text>StringSíNuevas instrucciones generales de extracción. Reemplaza el valor existente.

Ejemplo​

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

Forma de datos (--json de salida)​

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

uip proyectos ixp get-taxonomy​

Exporta el artefacto de taxonomía IXP sin procesar del proyecto (tipos de datos + grupos de campos). Este es un formato interno de Extracción y Procesamiento Inteligentes (IXP) destinado a reimportarse en otro proyecto (import-taxonomy), no una vista seleccionada y legible por humanos.

Argumentos​

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

Ejemplo​

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

Forma de datos (--json de salida)​

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

Data se reenvía textualmente en el propio caso_serpiente del conjunto de datos ascendente, no en PascalCased.

taxonomía de importación de proyectos ixp de uip​

Importa una taxonomía desde un archivo JSON local a un proyecto existente. Acepta dos formatos de archivo: { field_types, label_group } (la forma que produce get-taxonomy/taxonomy-suggestion) o { entity_defs, label_groups } (la forma que devuelve el propio punto final de taxonomía) — entity_defs/la primera entrada label_groups se pasa tal cual cuando se le da el segundo formato, para preservar propiedades como inherits_from requiere la API.

Argumentos​

NombreObligatorioPropósito
<project-name>SíNombre del proyecto.
<file>SíRuta al archivo JSON de taxonomía.

Ejemplo​

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

Forma de datos (--json de salida)​

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

Falla con un error explícito si el archivo no tiene forma reconocida (faltan field_types y label_group después de la normalización).

configurar-modelo de proyectos ixp de UIP​

Configura los ajustes del modelo de extracción para un proyecto. El proxy lee la configuración actual, la fusiona en el modelo/preprocesamiento proporcionado, la vuelve a escribir y devuelve la configuración fusionada.

Argumentos​

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

Opciones​

LargoValorDescripción
--model <version>StringNombre del modelo de extracción, del lado del servidor validado (por ejemplo gemini_2_5_flash, gemini_2_5_pro, gpt_4o_2024_05_13).
--preprocessing <type>none|table_mini|tableModo de preprocesamiento inteligente.

Se requiere al menos uno de --model/--preprocessing: pasar ninguno falla en el lado del cliente antes de cualquier llamada ("Nada que configurar").

Ejemplo​

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

Forma de datos (--json de salida)​

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

uip proyectos ixp get-metrics​

Obtener métricas de validación para un proyecto de Extracción y Procesamiento Inteligentes (IXP).

Argumentos​

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

Opciones​

CortoLargoValorPredeterminadoDescripción
-m--model-version <version>entero o latestlatestVersión del modelo para la que obtener métricas.

Ejemplos​

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

Forma de datos (--json de salida)​

{
  "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" }
    ]
  }
}
{
  "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 modelo que existe pero que aún no se ha validado devuelve { "Metrics": null } en lugar de la forma plana anterior.

publicación de proyectos ixp de uip​

Publica una versión del modelo, etiquetándola opcionalmente live o staging.

Argumentos​

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

Opciones​

CortoLargoValorDescripción
-m--model-version <version>EnteroVersión del modelo que se va a publicar. El valor predeterminado es la versión entrenada más reciente (más alta).
—--tag <live|staging>live|stagingOpcionalmente, etiqueta la versión publicada.
-d--description <text>StringDescripción de la versión publicada. Una cadena vacía borra una existente.

Ejemplos​

uip ixp projects publish my-invoices --model-version 4 --tag live --description "Q2 release"
uip ixp projects publish my-invoices --model-version 4 --tag live --description "Q2 release"
uip ixp projects publish my-invoices --model-version 4
uip ixp projects publish my-invoices --model-version 4
# --model-version defaults to the latest trained version
uip ixp projects publish my-invoices
# --model-version defaults to the latest trained version
uip ixp projects publish my-invoices

Forma de datos (--json de salida)​

{
  "Code": "IxpProjectsPublish",
  "Data": {
    "ProjectName": "my-invoices",
    "ModelVersion": 4,
    "Pinned": true,
    "Tag": { "Name": "live", "Version": 4, "UpdatedAt": "2026-04-29T00:00:00Z" },
    "Description": "Q2 release"
  }
}
{
  "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 es null cuando se omitió --tag.

anular la publicación de proyectos ixp de uip​

Cancelar la publicación de una versión del modelo. La versión permanece entrenada y listable; solo se elimina del conjunto publicado.

Argumentos​

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

Opciones​

CortoLargoValorObligatorioDescripción
-m--model-version <version>entero no negativoSíVersión del modelo para anular la publicación.

Ejemplo​

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

Forma de datos (--json de salida)​

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

desetiquetar proyectos ixp de uip​

Eliminar una etiqueta de una versión del modelo por nombre. Los nombres de las etiquetas son únicos dentro de un proyecto, por lo que esto es inequívoco incluso si una versión contiene varias etiquetas. La versión permanece entrenada y publicada; solo se borra su puntero de etiqueta.

Argumentos​

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

Opciones​

LargoValorObligatorioDescripción
--tag <live|staging>live|stagingSíEtiqueta a eliminar, por nombre.

Ejemplo​

uip ixp projects untag my-invoices --tag live
uip ixp projects untag my-invoices --tag live

Forma de datos (--json de salida)​

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

modelos de lista de proyectos ixp de UIP​

Enumera todas las versiones y etiquetas del modelo para un proyecto.

Argumentos​

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

Ejemplo​

uip ixp projects list-models my-invoices
uip ixp projects list-models my-invoices

Forma de datos (--json de salida)​

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

creación de proyectos ixp de uip​

Crea un proyecto de Extracción y Procesamiento Inteligentes (IXP). Dada una carpeta de documentos, los carga y sugiere una taxonomía de hasta 8 documentos muestreados uniformemente; sin una carpeta, crea un proyecto vacío.

Argumentos​

NombreObligatorioPropósito
<name>SíNombre del proyecto.
[folder-path]NoRuta a una carpeta de documentos. Omitir para crear un proyecto vacío: sin carga, no es posible ninguna sugerencia de taxonomía sin documentos.

Opciones​

CortoLargoDescripción
-d--description <text>Descripción de qué extraer de los documentos: utilizada como contexto para la sugerencia de taxonomía.
—--skip-taxonomyCrea el proyecto y carga los documentos sin sugerir una taxonomía.

Las cargas continúan en caso de fallos de archivos individuales (cada fallo se recopila, no es fatal): el comando solo falla por completo si fallan todas las cargas en la carpeta. La sugerencia de taxonomía se reintenta hasta 3 veces con un retraso de 5 segundos (el backend puede 500 intermitentemente mientras el OCR aún no está listo para un PDF); si los 3 intentos fallan, el proyecto y sus documentos aún se crean: el error nombra el comando import-taxonomy exacto que se ejecutará después.

Ejemplos​

uip ixp projects create "My Invoices" ./training-set --description "extract invoice header fields"
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" ./training-set --skip-taxonomy
uip ixp projects create "My Invoices"
uip ixp projects create "My Invoices"

Forma de datos (--json de salida)​

{
  "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
  }
}
{
  "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 (una matriz de {file, error}) está presente solo cuando al menos una carga ha fallado. Cuando la sugerencia de taxonomía tiene éxito, SuggestedTaxonomy se añade con FieldTypes (pares de nombre/título) y LabelGroup (nombre más LabelDefs). Cuando se pasó --skip-taxonomy, se añade TaxonomySkipped: true en su lugar. <name> se devuelve slugified y con un sufijo con un ID aleatorio y -ixp — no es la cadena literal que pasaste.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado