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

contexto do agente de uip

uip agent context gerencia recursos de contexto em um projeto de agente — as associações de índice RAG (retrieval-augmented generation) que o agente consulta no runtime. Cada contexto é uma referência nomeada para um índice, além de um modo de recuperação e parâmetros de pontuação. O comando grava diretamente no projeto do agente no disco ( puramente local — sem necessidade de login).

Resumo

uip agent context add    <name> --index <indexName>
                                [--retrieval-mode <mode>] [--threshold <n>] [--result-count <n>]
                                [--path <dir>]
uip agent context list                                    [--path <dir>]
uip agent context remove <name>                           [--path <dir>]
uip agent context add    <name> --index <indexName>
                                [--retrieval-mode <mode>] [--threshold <n>] [--result-count <n>]
                                [--path <dir>]
uip agent context list                                    [--path <dir>]
uip agent context remove <name>                           [--path <dir>]

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

adição de contexto do agente uip

Adicione um recurso de contexto RAG ao agente.

Argumentos

  • ( <name> ) — Nome do recurso de contexto. Usado para remoção posterior (context remove <name>).

Opções

BandeiraPadrãoRequiredFinalidade
--index <indexName>simNome do índice do qual recuperar.
--retrieval-mode <mode>semanticModo de recuperação. Um destes: semantic, structured, deeprag, batchtransform.
--threshold <n>0Limite de pontuação de recuperação (numérico). Os valores abaixo desse limite são descartados.
--result-count <n>3Número de resultados a serem recuperados por consulta (inteiro).
--path <path>.Caminho para o diretório do projeto do agente.

Entradas numéricas inválidas para --threshold ou --result-count falham com um erro de validação.

Exemplos

# Semantic RAG with defaults (threshold 0, 3 results)
uip agent context add KnowledgeBase --index docs-index --path ./my-agent

# Tighter recall: higher threshold, more results
uip agent context add KnowledgeBase \
  --index docs-index \
  --retrieval-mode semantic \
  --threshold 0.7 \
  --result-count 5

# Structured retrieval over a different index
uip agent context add Tickets \
  --index ticket-index \
  --retrieval-mode structured
# Semantic RAG with defaults (threshold 0, 3 results)
uip agent context add KnowledgeBase --index docs-index --path ./my-agent

# Tighter recall: higher threshold, more results
uip agent context add KnowledgeBase \
  --index docs-index \
  --retrieval-mode semantic \
  --threshold 0.7 \
  --result-count 5

# Structured retrieval over a different index
uip agent context add Tickets \
  --index ticket-index \
  --retrieval-mode structured

Formato dos dados (--output json)

{
  "Code": "AgentContextAdd",
  "Data": {
    "Status": "Context added",
    "Name": "KnowledgeBase",
    "Index": "docs-index",
    "Mode": "semantic",
    "Id": "a1b2c3d4-0000-0000-0000-000000000010"
  }
}
{
  "Code": "AgentContextAdd",
  "Data": {
    "Status": "Context added",
    "Name": "KnowledgeBase",
    "Index": "docs-index",
    "Mode": "semantic",
    "Id": "a1b2c3d4-0000-0000-0000-000000000010"
  }
}

Id é um UUID gerado carimbo no recurso. Use o Name ou o Id com context remove.

lista de contexto do agente uip

Enumerar os recursos de contexto configurados no agente.

Opções

BandeiraPadrãoFinalidade
--path <path>.Caminho para o diretório do projeto do agente.

Exemplo

uip agent context list --path ./my-agent
uip agent context list --path ./my-agent

Formato dos dados (--output json)

{
  "Code": "AgentContextList",
  "Data": [
    {
      "Name": "KnowledgeBase",
      "Index": "docs-index",
      "Mode": "semantic",
      "Id": "a1b2c3d4-0000-0000-0000-000000000010"
    }
  ]
}
{
  "Code": "AgentContextList",
  "Data": [
    {
      "Name": "KnowledgeBase",
      "Index": "docs-index",
      "Mode": "semantic",
      "Id": "a1b2c3d4-0000-0000-0000-000000000010"
    }
  ]
}

Os projetos vazios retornam Data: { "Message": "No contexts configured" }.

remoção de contexto do agente uipath

Remova um recurso de contexto.

Argumentos

  • <name> necessário) — Nome ou ID do contexto.

Opções

BandeiraPadrãoFinalidade
--path <path>.Caminho para o diretório do projeto do agente.

Exemplo

uip agent context remove KnowledgeBase --path ./my-agent
uip agent context remove KnowledgeBase --path ./my-agent

Formato dos dados (--output json)

{
  "Code": "AgentContextRemove",
  "Data": {
    "Status": "Context removed",
    "Name": "KnowledgeBase"
  }
}
{
  "Code": "AgentContextRemove",
  "Data": {
    "Status": "Context removed",
    "Name": "KnowledgeBase"
  }
}

Um contexto ausente falha com Context "<name>" not found e código de saída 1.

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