Projetos do UIP Extração e Processamento Inteligente (IXP)

Sintaxe e opções para "projetos uip ixp", que cria e gerencia projetos de treinamento de IXP — publicação de modelos, métricas e importação/exportação de taxonomia.

uip ixp projects cria e gerencia projetos de treinamento do IXP: o contêiner de nível superior para uma taxonomia, documentos de treinamento e versões do modelo treinado. Consulte Conceitos na página pai para obter o modelo de taxonomia e a visão geral do loop de treinamento.

Resumo

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 projetos do uip iXp

Liste todos os projetos de treinamento de Extração e Processamento Inteligente (IXP) no tenant.

Opções

Short	Long	Valor	Padrão	Description
-l	--limit <number>	1-10000	50	Número de itens a serem retornados.
—	--offset <number>	0 a 1000000	0	Número de itens a serem ignorados.

Exemplo

uip ixp projects list

Formato dos dados (--output 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
  }
}

A resposta inteira, incluindo Data, é encaminhada do texto da API do IXP — as chaves mantêm seu PascalCase nativo aqui, mas consulte a nota de cada um dos outros verbos sobre o uso de maiúsculas e minúsculas, pois varia de acordo com o endpoint.

projetos uip iXp obter

Obtenha um projeto de treinamento de Extração e Processamento Inteligente (IXP) pelo nome.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Exemplo

uip ixp projects get my-invoices

Formato dos dados (--output 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"
  }
}

exclusão de projetos uipath IXP

Exclua permanentemente um projeto — seus documentos, taxonomia e modelos treinados. Irreversível; requer --yes.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Short	Long	Description
-y	--yes	Confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplo

uip ixp projects delete my-invoices --yes

Formato dos dados (--output json)

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

títulos de atualização de projetos IXP do UIP

Atualizar o título de exibição de um projeto. O proxy mantém o conjunto de dados e os títulos de projetos sincronizados no lado do servidor.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
<new-title>	sim	Novo título de exibição.

Exemplo

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

Formato dos dados (--output 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"
  }
}

projetos-uip IXP - update-prompt

Atualize as instruções gerais de extração do projeto — o prompt de toda a taxonomia fornecendo ao modelo contexto relevante em cada grupo de campos. Corresponde às "Instruções gerais de extração" da interface gráfica do IXP. na página Gerenciar taxonomia. Diferenciado do próprio prompt de um grupo de campos (taxonomy groups update-prompts) e dos prompts por campo (taxonomy fields update-prompts).

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Long	Valor	Required	Description
--prompt <text>	String	sim	Novas instruções gerais de extração. Substitui o valor existente.

Exemplo

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

Formato dos dados (--output json)

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

projetos uip IXP get-taxonomy

Exporte o artefato de taxonomia IXP bruto do projeto (tipos de dados + grupos de campos). Este é um formato do IXP interno destinado a reimportação para outro projeto (import-taxonomy), não uma visualização selecionada e legível por humanos.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Exemplo

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

Formato dos dados (--output json)

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

Data é encaminhado textual do próprio conjunto de dados upstream, não no PascalCased.

projetos uip IXP: taxonomia

Importe uma taxonomia de um arquivo JSON local para um projeto existente. Aceita dois formatos de arquivo: { field_types, label_group } (a forma get-taxonomy/sugestão de taxonomia produz) ou { entity_defs, label_groups } (a forma que o próprio endpoint da taxonomia retorna) — entity_defs/a primeira entrada label_groups são passadas como estão quando fornecido o segundo formato, para preservar propriedades como inherits_from a API exige.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
<file>	sim	Caminho para o arquivo JSON de taxonomia.

Exemplo

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

Formato dos dados (--output json)

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

Falha com um erro explícito se o arquivo não tiver nenhuma forma reconhecida (faltando field_types e label_group após a normalização).

projetos uip iXp configurar-model

Defina as configurações do modelo de extração para um projeto. O proxy lê a configuração atual, mescla no modelo/pré-processamento fornecido, grava-o de volta e retorna a configuração mesclada.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Long	Valor	Description
--model <version>	String	Nome do modelo de extração, validado no lado do servidor (por exemplo gemini_2_5_flash, gemini_2_5_pro, gpt_4o_2024_05_13).
--preprocessing <type>	none|table_mini|table	Modo de pré-processamento inteligente.

Pelo menos um dos --model/--preprocessing é necessário — não passar nenhum dos dois falha no lado do cliente antes de qualquer chamada ("Nada para configurar").

Exemplo

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

Formato dos dados (--output json)

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

projetos uip IXP get-metrics

Obtenha métricas de validação para um projeto de IXP.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Short	Long	Valor	Padrão	Description
-m	--model-version <version>	inteiro ou latest	latest	Versão do modelo para o qual obter métricas.

Exemplos

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

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

Formato dos dados (--output 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" }
    ]
  }
}

Um modelo que existe, mas que ainda não foi validado retorna { "Metrics": null } em vez da forma fixa acima.

Publicação de projetos UIPS IXP

Publique uma versão do modelo, opcionalmente marcando-a live ou staging.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Short	Long	Valor	Description
-m	--model-version <version>	Número inteiro	Versão do modelo a ser publicada. O padrão é a versão treinada mais recente (a mais alta).
—	--tag <live|staging>	live|staging	Opcionalmente, marque a versão publicada.
-d	--description <text>	String	Descrição da versão publicada. Uma string vazia limpa uma existente.

Exemplos

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

Formato dos dados (--output 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 é null quando --tag foi omitido.

cancelamento de publicação de projetos do UIP IXP

Cancele a publicação de uma versão do modelo. A versão permanece treinada e listável; ela é removida apenas do conjunto publicado.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Short	Long	Valor	Required	Description
-m	--model-version <version>	número inteiro não negativo	sim	Versão do modelo para cancelar a publicação.

Exemplo

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

Formato dos dados (--output json)

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

Desmarcação de projetos do UIP IXP

Remova uma tag de uma versão de modelo por nome. Os nomes das tags são exclusivos dentro de um projeto; portanto, isso é inequívoco, mesmo que uma versão tenha várias tags. A versão permanece treinada e publicada; apenas seu ponteiro de tag é desmarcado.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Long	Valor	Required	Description
--tag <live|staging>	live|staging	sim	Tag a ser removida, por nome.

Exemplo

uip ixp projects untag my-invoices --tag live

Formato dos dados (--output json)

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

projetos-modelos de lista de projetos IXP do UIP

Lista todas as versões do modelo e tags de um projeto.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Exemplo

uip ixp projects list-models my-invoices

Formato dos dados (--output json)

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

projetos uip IXP criação

Crie um projeto do IXP. Dada uma pasta de documentos, os carrega e sugere uma taxonomia de até 8 documentos com amostra uniforme; sem uma pasta, cria um projeto vazio.

Argumentos

Name	Required	Finalidade
<name>	sim	Nome do projeto.
[folder-path]	não	Caminho para uma pasta de documentos. Omita para criar um projeto vazio — sem upload, nenhuma sugestão de taxonomia é possível sem documentos.

Opções

Short	Long	Description
-d	--description <text>	Descrição do que extrair dos documentos — usada como contexto para sugestão de taxonomia.
—	--skip-taxonomy	Crie o projeto e carregue documentos sem sugerir uma taxonomia.

Os uploads continuam em falhas de arquivos individuais (cada falha é coletada, não fatal) — o comando só falha totalmente se cada upload na pasta falhar. A sugestão da taxonomia repete até 3 vezes com um atraso de 5 segundos (o back-end pode intermitentemente 500 enquanto o OCR ainda não está pronto para um PDF); se todas as três tentativas falharem, o projeto e seus documentos ainda serão criados — o erro nomeia o comando import-taxonomy exato a ser executado posteriormente.

Exemplos

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"

Formato dos dados (--output 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 (uma matriz de {file, error}) estará presente apenas quando pelo menos um upload falhar. Quando a sugestão da taxonomia for bem-sucedida, SuggestedTaxonomy é adicionado com FieldTypes (pares nome/título) e LabelGroup (nome mais LabelDefs). Quando --skip-taxonomy foi passado, TaxonomySkipped: true foi adicionado. <name> é retornado com campo de dados dinâmico e sufixado com um ID aleatório e -ixp — não é a string literal que você passou.

Relacionado

• uip ixp — conceitos e o diretório completo de recursos.
• taxonomia uiip ixp — edite tipos de dados, grupos e campos um de cada vez (vs. a taxonomia completa desta página get-taxonomy/import-taxonomy).
• Documentos e rotulagem do uip IXP — carregue documentos e revise previsões.
• implantações uiip IXP — implante uma versão do modelo publicado no Orchestrator.

Veja também

• Visão geral da ferramenta de Extração e Processamento Inteligente (IXP)
• Opções globais
• Códigos de saída