UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Agente de UIP

Estruture, valide, atualize, revise e gerencie agentes de pouco código usando a ferramenta "uip agent".

uip agent a ferramenta do agente: ele estrutura, valida, migra e revisa agentes de pouco código — os projetos orientados por agent.jsoncriados no Agent Builder / Studio Web. Instale-o com uip tools install agent ou invoque uip agent … e deixe a instalação automática ser executada. Consulte Ferramentas ( plugins ) para ver o modelo de instalação e ferramentas uip para o comando que gerencia a instalação da ferramenta.

Essa ferramenta é distinta da ferramenta de agente codificada (uip codedagent), que tem como alvo agentes do Python criados com Agentes LangGraph/LlamaIndex/OpenAI. uip agent opera apenas em projetos de agente de pouco código: um diretório contendo agent.json, entry-points.json, project.uiproj, uma árvore evals/ e pastas features/ / resources/ — ou, para um agente incorporado em um Maestro Flow, um subdiretório nomeado por UUID dentro do projeto de fluxo (--inline-in-flow).

uip agent não tem pack, publish, deploy, push, pull, run, list, share, file, config, context, escalation, input, ou output — o empacotamento e o envio de um projeto de agente passa por uip solution (o projeto do agente é um projeto dentro de uma solução). A criação de recursos (ferramentas, contextos, escalonamentos, esquema de E/O) é feita editando manualmente agent.json, não por meio de um verbo CLI dedicado.

O que é um agente da UiPath​

Um agente de pouco código é descrito declarativamente por um único arquivo agent.json — modelo, prompts, esquemas de entrada/saída, ferramentas, contextos, escalonamentos e configurações. Os arquivos de suporte descrevem os pontos de entrada que o Studio Web usa para invocar o agente, o conjunto de avaliação padrão e quaisquer recursos RAG/HITL.

O ciclo de vida real coberto por uip agent é:

  1. Estruture um projeto no disco com uip agent init (independente ou --inline-in-flow dentro de um projeto do Maestro Flow). Por padrão, o projeto registra automaticamente no .uipx de uma solução adjacente, ou um novo <Name>Solution é estruturado automaticamente quando não existe nenhum.
  2. Crie editando manualmente agent.json (e os arquivos sob resources/, evals/).
  3. Atualizar o projeto (uip agent refresh) após cada edição — aplica migrações de esquema pendentes e regenera entry-points.json / bindings_v2.json. Esse é o único comando que grava arquivos derivados.
  4. Validar o projeto (uip agent validate) — restrito, somente leitura: respostas "o Studio Web aceitaria esse diretório como está?" sem escrever nada.
  5. Revise o projeto em relação a um conjunto de regras determinísticas (uip agent review) para obter um veredicto de qualidade pontuado e, opcionalmente, registre a nota ao longo do tempo (uip agent review-history add).
  6. Configure modelos de LLM (uip agent model list), espaços de memória (uip agent memory), proteções (uip agent guardrails) e ferramentas (uip agent tool list), conforme necessário.
  7. Depure o agente no Studio Web (uip agent debug) para executá-lo de ponta a ponta com entradas de amostra antes do envio.
  8. Enviado com uip solution pack / publish / upload / deploy — uip agent não tem verbo de empacotamento ou implantação próprio.
  9. Avaliar o agente em relação a um conjunto de avaliação (uip agent eval run start) — funciona em uma solução enviada pela nuvem (--solution-id) ou detectada automaticamente a partir de SolutionStorage.json) ou, quando nenhum dos dois estiver disponível, um caminho de avaliação do espaço de trabalho local implícito.

Verbo​

CommandFinalidade
InitEstruture um novo projeto de agente no disco (independente ou em linha dentro de um projeto de fluxo).
ValidarVerificação rigorosa de somente leitura: o Studio Web aceitaria este projeto como está?
refreshAplique as migrações de esquema pendentes e gere novamente entry-points.json / bindings_v2.json.
RevisãoPontuar o projeto em relação a um conjunto de regras determinísticas (veredicto, pontuação, classificação, problemas).
histórico-de-revisãoGrave uma nota de revisão no arquivo de histórico de revisão local do projeto.
Lista de ferramentasListe os recursos de ferramentas configurados no agente.
MemóriaAnexe, liste e remova espaços de memória e itens de memória.
AvaliaçãoGerenciar avaliadores, conjuntos de avaliação, casos de teste e execuções de avaliação.
ProteçõesListe definições de proteções, proteções BYOG, modelos de LLM como juiz e o catálogo de proteções.
modelListe os modelos de LLM disponíveis para o tenant autenticado.
DepuraçãoExecute o agente no Studio Web com entradas de amostra e transmita o resultado.

Resumo​

uip agent <verb> [subverb] [arguments] [options]
uip agent <verb> [subverb] [arguments] [options]

Sempre uip agent, nunca uip agents ou uip a. agent é commandPrefix da ferramenta (consulte uip tools list).

Todos os verbos uip agent respeitam as quatro opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato compartilhado.

Fluxo de ponta a ponta​

# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4

# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent

# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent

# 4. Review for quality issues before shipping
uip agent review ./my-agent

# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .

# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait

# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'
# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4

# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent

# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent

# 4. Review for quality issues before shipping
uip agent review ./my-agent

# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .

# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait

# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'

Autenticação​

debug, eval run *, guardrails llm-as-judge-models e model list chamam o Studio Web/o gateway do LLM e exigem uma sessão de CLI ativa. Execute uip login primeiro. Consulte Autenticação para o modelo de sessão.

init, validate, refresh, review, review-history, tool list, memory, guardrails list e guardrails catalog são somente locais e não exigem uma sessão.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades