- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- UiPath para agentes de codificação
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- Documento da UIP
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- restore
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- UIA
- Traces da UIP
- Migração
- Referência e suporte
Guia do usuário da UiPath CLI
uip agent a ferramenta do agente: ele estrutura, configura, valida, empacota e opera 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/ .
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 típico coberto por uip agent é:
- Estruture um projeto no disco com
uip agent init. - Autor: atualize
agent.jsondiretamente ou por meio dos verbos de gerenciamento de recursos (tool,context,escalation,input,output,eval). - Validar o projeto (
uip agent validate) — executa verificações estáticas e o pipeline de migração de esquema. - Envie o projeto para o Studio Web para que ele apareça na interface do usuário do Agent Builder (
uip agent push) ou continue editando localmente e empacote- o em um arquivo.uis(uip agent pack). - Publique o agente empacotado no Orchestrator como uma versão do pacote da solução (
uip agent publish). - Implantar o pacote publicado em uma pasta (
uip agent deploy) — isso cria a pasta, instala o processo, provisiona uma máquina sem servidor e um usuário de robô e ativa a implantação. - Execute o agente implantado como um trabalho (
uip agent run start) e monitore-o (uip agent run status,uip agent run list). - Avalie o agente em relação a um conjunto de avaliação (
uip agent eval run start), revise os resultados (uip agent eval run results) e compare com uma linha de base (uip agent eval run compare).
As operações que retornam um projeto do e para o Studio Web usam o par push / pull e os verbos de compartilhamento list / share . As operações no nível do arquivo dentro de um projeto do Studio Web são expostas por meio de uip agent file.
Verbo
| Command | Finalidade |
|---|---|
| Init | Estruture um novo projeto de agente no disco (independente ou em linha dentro de um projeto de fluxo). |
| Configuração | Leia ou atualize as chaves em agent.json (model, name, systemPrompt, etc.). |
| Validar | Verifique estático o projeto e execute o pipeline de esquema-migração; gravar arquivos migrados de volta. |
| Ferramenta | Adicionar, descobrir, conectar, listar ou remover ferramentas de agente (Integration Service / processo / fluxo de trabalho de API / etc.). |
| Contexto | Adicione, liste ou remova recursos de contexto de RAG vinculados a fontes de índice. |
| Escalonamento | Adicionar, listar ou remover recursos de HITL/escalonamento. |
| Entrada / saída | Gerenciar os parâmetros do esquema de entrada e saída do agente. |
| Avaliação | Gerenciar avaliadores, conjuntos de avaliação, casos de teste e execuções de avaliação. |
| Empacotar | Agrupe o projeto em um arquivo .uis . |
| Publicar | Empacote e envie o agente para o Orchestrator como uma versão do pacote da solução. |
| Implantar | Instale e ative uma versão do pacote publicada em uma pasta do Orchestrator. |
| Executar | Inicie, inspecione e liste trabalhos de agentes no Orchestrator. |
| List | Lista soluções visíveis para o usuário atual no Studio Web. |
| Efetuar Pull | Baixa uma solução do Studio Web como um arquivo .uis . |
| Enviar por Push | Importe um projeto local para o Studio Web. |
| .xml | Listar, baixar e carregar arquivos dentro de um projeto do Studio Web. |
| Compartilhar | Conceda, liste ou revogue acesso de usuário/grupo a uma solução do Studio Web. |
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
O fluxo mínimo esperado de zero para um agente implantado em execução:
# 1. Scaffold
uip agent init ./my-agent --model gpt-4o-2024-11-20
# 2. Validate (run after any edit to agent.json)
uip agent validate ./my-agent
# 3a. Iterate in Studio Web (optional)
uip agent push ./my-agent
# …edit in Studio Web, then pull back:
uip agent pull <solutionId> -d ./downloads --extract
# 3b. Or pack locally for inspection
uip agent pack ./my-agent -d ./dist
# 4. Publish to Orchestrator
uip agent publish ./my-agent --package-version 1.0.0
# → captures PackageVersionKey
# 5. Deploy to a folder (auto-creates folder + provisions machine and user)
uip agent deploy <PackageVersionKey> --name invoice-agent
# 6. Find the release, then run
uip agent run list --folder-id <FolderId>
uip agent run start <ReleaseKey> -i '{"input":"hello"}'
uip agent run status <JobId>
# 7. Evaluate (push must have happened first — eval runs against the cloud project)
uip agent eval run start --set default --path ./my-agent --wait
# 1. Scaffold
uip agent init ./my-agent --model gpt-4o-2024-11-20
# 2. Validate (run after any edit to agent.json)
uip agent validate ./my-agent
# 3a. Iterate in Studio Web (optional)
uip agent push ./my-agent
# …edit in Studio Web, then pull back:
uip agent pull <solutionId> -d ./downloads --extract
# 3b. Or pack locally for inspection
uip agent pack ./my-agent -d ./dist
# 4. Publish to Orchestrator
uip agent publish ./my-agent --package-version 1.0.0
# → captures PackageVersionKey
# 5. Deploy to a folder (auto-creates folder + provisions machine and user)
uip agent deploy <PackageVersionKey> --name invoice-agent
# 6. Find the release, then run
uip agent run list --folder-id <FolderId>
uip agent run start <ReleaseKey> -i '{"input":"hello"}'
uip agent run status <JobId>
# 7. Evaluate (push must have happened first — eval runs against the cloud project)
uip agent eval run start --set default --path ./my-agent --wait
Autenticação
Cada verbo que conversa com o Studio Web ou o Orchestrator (push, pull, list, share, publish, deploy, run *, eval run *, file *) requer uma CLI válida sessão. Execute uip login primeiro. Consulte Autenticação para o modelo de sessão e o comportamento --login-validity .
Verbos somente locais (init, config, validate, pack, tool, context, escalation, input, output, eval add / eval set / eval evaluator) operam exclusivamente em arquivos e não exigem uma sessão.
Veja também
- Conceitos: ferramentas ( plugins ) — o modelo de plugin e a fixar versão.
- Conceitos: habilidades — como os agentes aparecem como habilidades e como as habilidades se relacionam com recursos de ferramentas.
- Autenticação — sessões, tenants e pastas.
- Orchestrator: trabalhos — as APIs de trabalhos subjacentes para as quais
uip agent rundelega.