UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

inicialização do agente da uip

uip agent init estrutura um novo projeto de agente de pouco código no disco. Cria apenas os arquivos de projeto do agente — não cria ou vincula uma solução. Use uip solution new seguido de uip solution project add para colocar o agente com estrutura de dados dentro de uma solução.

Dois modos de estruturação estão disponíveis:

  • Independente (padrão) — uma árvore de projeto de agente completa com agent.json, entry-points.json, project.uiproj, flow-layout.json, uma árvore evals/ (com um conjunto de avaliação padrão, avaliador semântico e avaliador de trajetória), mais features/ vazio e resources/ .
  • Em linha no fluxo (--inline-in-flow) — um subdiretório nomeado por UUID dentro de um projeto de fluxo existente contendo agent.json e um flow-layout.json vazio, com pastas vazias evals/eval-sets/, features/ e resources/ . Não há entry-points.json ou project.uiproj. O nó do agente embutido do fluxo deve fazer referência ao projectId gerado.

Resumo

uip agent init <path> [--model <model>] [--system-prompt <prompt>] [--force] [--inline-in-flow]
uip agent init <path> [--model <model>] [--system-prompt <prompt>] [--force] [--inline-in-flow]

Todas as invocações uip agent init honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

Argumentos

  • <path> necessário) — Diretório de destino para o projeto do agente (relativo ou absoluto). O nome do diretório se torna o nome do agente no modo independente; ele deve corresponder [a-zA-Z0-9_ -]+. Quando --inline-in-flow é usado, <path> é o diretório do projeto de fluxo e um subdiretório nomeado pelo UUID é criado dentro dele.

Opções

BandeiraPadrãoFinalidade
--model <model>gpt-4o-2024-11-20Modelo de LLM que o agente usará. Gravado em settings.model em agent.json.
--system-prompt <prompt>Prompt inicial do sistema gravado messages[0] de agent.json. Importante apenas no modo autônomo.
--forcedesativadaSubstitui o diretório de destino mesmo se não estiver vazio. Apenas modo independente — o modo em linha sempre grava em uma pasta UUID nova.
--inline-in-flowdesativadaEstruture um agente em linha dentro de um projeto de fluxo. <path> argumento deve apontar para um diretório de projeto de fluxo existente (caso contrário, erro).

O modo independente se recusa a prosseguir se o diretório de destino existir e contiver algum arquivo, a menos que --force esteja definido.

Exemplos

# Simplest: scaffold with defaults into ./my-agent
uip agent init ./my-agent

# Override the model and seed a system prompt
uip agent init ./invoice-agent \
  --model gpt-4o-2024-11-20 \
  --system-prompt "You are an invoice triage agent."

# Overwrite an existing non-empty directory
uip agent init ./my-agent --force

# Scaffold an inline agent inside an existing flow project
uip agent init ./my-flow --inline-in-flow
# Simplest: scaffold with defaults into ./my-agent
uip agent init ./my-agent

# Override the model and seed a system prompt
uip agent init ./invoice-agent \
  --model gpt-4o-2024-11-20 \
  --system-prompt "You are an invoice triage agent."

# Overwrite an existing non-empty directory
uip agent init ./my-agent --force

# Scaffold an inline agent inside an existing flow project
uip agent init ./my-flow --inline-in-flow

Formato dos dados (--output json)

Independente (Code: "AgentInit"):

{
  "Code": "AgentInit",
  "Data": {
    "Status": "Agent project created",
    "Path": "./my-agent",
    "Name": "my-agent",
    "Model": "gpt-4o-2024-11-20",
    "ProjectId": "a1b2c3d4-0000-0000-0000-000000000301",
    "NextSteps": "# Edit agent.json to configure prompts and resources\n…"
  }
}
{
  "Code": "AgentInit",
  "Data": {
    "Status": "Agent project created",
    "Path": "./my-agent",
    "Name": "my-agent",
    "Model": "gpt-4o-2024-11-20",
    "ProjectId": "a1b2c3d4-0000-0000-0000-000000000301",
    "NextSteps": "# Edit agent.json to configure prompts and resources\n…"
  }
}

Em linha (Code: "AgentInitInline"):

{
  "Code": "AgentInitInline",
  "Data": {
    "Status": "Inline agent created inside flow project",
    "Path": "/abs/path/my-flow/<uuid>",
    "ProjectId": "<uuid>",
    "Model": "gpt-4o-2024-11-20",
    "NextSteps": "# Edit agent.json to configure prompts and settings\n…"
  }
}
{
  "Code": "AgentInitInline",
  "Data": {
    "Status": "Inline agent created inside flow project",
    "Path": "/abs/path/my-flow/<uuid>",
    "ProjectId": "<uuid>",
    "Model": "gpt-4o-2024-11-20",
    "NextSteps": "# Edit agent.json to configure prompts and settings\n…"
  }
}

ProjectId é um UUID novo carimbos em agent.json e — no modo em linha — também é o nome da pasta. No modo independente, UUIDs adicionais são gerados para o ponto de entrada, o avaliador semântico, o avaliador de trajetória e o conjunto de avaliação padrão.

Arquivos gerados

Criações autônomas :

<path>/
  agent.json
  project.uiproj
  entry-points.json
  flow-layout.json
  evals/
    evaluators/
      <semantic-evaluator>.json
      <trajectory-evaluator>.json
    eval-sets/
      evaluation-set-default.json
  features/
  resources/
<path>/
  agent.json
  project.uiproj
  entry-points.json
  flow-layout.json
  evals/
    evaluators/
      <semantic-evaluator>.json
      <trajectory-evaluator>.json
    eval-sets/
      evaluation-set-default.json
  features/
  resources/

Inline-in-flow cria, dentro do projeto de fluxo:

<flow-path>/<new-uuid>/
  agent.json
  flow-layout.json           # empty ({})
  evals/eval-sets/
  features/
  resources/
<flow-path>/<new-uuid>/
  agent.json
  flow-layout.json           # empty ({})
  evals/eval-sets/
  features/
  resources/
  • uip agent validate — execute verificações estáticas e migração de esquema após editar o estruturado agent.json.
  • uip agent config — Atualize chaves individuais em agent.json sem editar manualmente o arquivo.
  • uip agent input / uip agent output — gerencie o esquema de entrada e saída do agente após a estruturação.
  • uip agent push — envie o projeto com Scaffolded para o Studio Web.

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