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.

Depuração do agente do UIP

Execute um agente de pouco código no Studio Web com entradas de amostra e transmita o resultado com a "uip agent debug".

uip agent debug executa um agente de pouco código de ponta a ponta no Studio Web com as entradas que você fornece, pesquisando até que a execução termine e o estado de transmissão mude. Exige login.

O projeto deve usar um manifesto project.uiproj — um projeto ainda no layout project.json antigo falha rapidamente com instruções de conversão (comandos de empacotamento como uip solution pack/publish ainda aceitam project.json; apenas comandos vinculados ao Studio-Web como este exige o manifesto mais recente).

Resumo​

uip agent debug <project-path> [-i <json>] [--attachment <field=path>]... [--poll-interval <ms>] [--timeout <seconds>] [--login-validity <minutes>]
uip agent debug <project-path> [-i <json>] [--attachment <field=path>]... [--poll-interval <ms>] [--timeout <seconds>] [--login-validity <minutes>]

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

Argumentos​

  • <project-path> (necessário) — Caminho para o diretório do projeto do agente (contendo agent.json).

Opções​

BandeiraPadrãoFinalidade
-i, --inputs <json>{}Insira argumentos como um objeto JSON. Por exemplo '{"input":"hello"}' Deve ser analisado como um objeto simples. Para um campo de anexo de trabalho, passe uma referência de anexo existente do Orchestrator, {"ID": "<attachment-id>"}, ou use --attachment para carregar um arquivo local.
--attachment <field=path>—Carregue um arquivo local em um campo de entrada de anexo de trabalho de agent.json. Repetível. O campo deve ser declarado como {"$ref": "#/definitions/job-attachment"} em inputSchema. Repetir o mesmo campo apenas quando o esquema for um array de anexos de trabalho. O caminho é resolvido a partir do diretório de trabalho atual, não do diretório do projeto do agente. As IDs de anexo carregadas são retornadas em Data.Attachments.
--poll-interval <ms>2000Intervalo de pesquisa em milissegundos.
--timeout <seconds>600 segundos (10 minutos)Máximo de segundos para aguardar a conclusão da execução.
--login-validity <minutes>10Minutos mínimos restantes antes que a expiração do token seja necessário para prosseguir.

Exemplos​

uip agent debug ./my-agent -i '{"input":"hello"}'

uip agent debug ./my-agent --timeout 120 --poll-interval 5000

# Upload a local PDF into the job-attachment input field fileIn
uip agent debug ./my-agent --attachment fileIn=./invoice.pdf -i '{"question":"What is the total?"}'
uip agent debug ./my-agent -i '{"input":"hello"}'

uip agent debug ./my-agent --timeout 120 --poll-interval 5000

# Upload a local PDF into the job-attachment input field fileIn
uip agent debug ./my-agent --attachment fileIn=./invoice.pdf -i '{"question":"What is the total?"}'

An --attachment value for a field also present in --inputs overrides the --inputs value, and the command logs a warning. A required job-attachment input that has neither an --attachment nor an --inputs value also produces a warning.

Formato dos dados (--output json)​

Sucesso (Code: "AgentDebug"):

{
  "Code": "AgentDebug",
  "Data": {
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000401",
    "TraceId": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "Output": { "content": "hi there" }
  },
  "Instructions": "Debug run completed: Successful"
}
{
  "Code": "AgentDebug",
  "Data": {
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000401",
    "TraceId": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "Output": { "content": "hi there" }
  },
  "Instructions": "Debug run completed: Successful"
}

Output está presente apenas quando a execução produziu um; Info está presente apenas quando o serviço retorna informações de diagnóstico extras.

Quando a execução carrega arquivos com --attachment, Data.Attachments lista cada carregamento:

{
  "Code": "AgentDebug",
  "Data": {
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000401",
    "TraceId": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "Output": { "answer": "1,234.00 USD" },
    "Attachments": [
      {
        "Field": "fileIn",
        "AttachmentId": "c3d4e5f6-0000-0000-0000-000000000002",
        "FileName": "invoice.pdf",
        "MimeType": "application/pdf",
        "Size": 48213
      }
    ]
  }
}
{
  "Code": "AgentDebug",
  "Data": {
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000401",
    "TraceId": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "Output": { "answer": "1,234.00 USD" },
    "Attachments": [
      {
        "Field": "fileIn",
        "AttachmentId": "c3d4e5f6-0000-0000-0000-000000000002",
        "FileName": "invoice.pdf",
        "MimeType": "application/pdf",
        "Size": 48213
      }
    ]
  }
}

To reuse an uploaded file in a later run without uploading it again, pass its reference in --inputs, for example '{"fileIn":{"ID":"c3d4e5f6-0000-0000-0000-000000000002"}}'.

Erros de anexo — um valor --attachment inválido (formato field=path errado, um campo que não é uma entrada de anexo de trabalho, um caminho ausente, vazio ou de diretório) falha antes que qualquer coisa seja carregada ou executada, com Retry: "RetryWillNotFix". Quando o Orchestrator recusa um upload, nenhum trabalho de depuração é iniciado.

Estado terminal sem sucesso — o mesmo Code: "AgentDebug", mas retornado como uma falha (código de saída 1) com Message: "Debug run <state>." e Instructions apontando para uip traces spans get <TraceId> para inspecionar a execução.

Manifesto de projeto incompatível:

{
  "Result": "Failure",
  "ErrorCode": "invalid_argument",
  "Message": "...",
  "Instructions": "Convert the listed project(s) to a project.uiproj manifest before debugging: scaffold the accepted layout with 'uip api-workflow init <name>' inside the solution and move Workflow.json (plus entry-points.json and bindings_v2.json) into it, then remove the project.json-based entry from the .uipx. Note that 'uip solution pack' and 'uip solution publish' accept project.json — only Studio Web-bound commands require project.uiproj."
}
{
  "Result": "Failure",
  "ErrorCode": "invalid_argument",
  "Message": "...",
  "Instructions": "Convert the listed project(s) to a project.uiproj manifest before debugging: scaffold the accepted layout with 'uip api-workflow init <name>' inside the solution and move Workflow.json (plus entry-points.json and bindings_v2.json) into it, then remove the project.json-based entry from the .uipx. Note that 'uip solution pack' and 'uip solution publish' accept project.json — only Studio Web-bound commands require project.uiproj."
}
  • uip agent validate — execute primeiro para confirmar que o projeto está bem-formado; sugerido nas instruções de falha de upload.
  • uip traces spans get — inspecione o trace de uma execução de depuração após um estado não bem-sucedido.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades