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.

memória do agente uip

Sintaxe e opções para a "memória do agente uip", que anexa, lista e remove espaços de memória em um agente de pouco código e adiciona ou lista os itens que um espaço de memória implantado contém.

uip agent memory gerencia as funcionalidades de espaço de memória anexadas a um agente: um espaço de memória é uma origem de recall aumentada por recuperação que o agente pode pesquisar no runtime. uip agent memory item adiciona e lista os itens que um espaço de memória contém no runtime. Os itens vêm de execuções de agentes reais: feedback deixado no trace de uma execução (itens episódicas) ou um período de escalonamento que o agente gerou (itens de escalonamento).

memory add, memory list e memory remove editam o projeto do agente local. memory item add e memory item list leem e gravam o espaço de memória do runtime implantado e exigem login. Execute uip login primeiro.

Resumo​

uip agent memory add    <name> --memory-space <name> [--folder-path <path>] [--reference-key <key>] [--description <desc>] [--threshold <n>] [--result-count <n>] [--search-mode <hybrid|semantic>] [--field <name=weight>]... [--disable-dynamic-few-shot] [--path <dir>]
uip agent memory list   [--path <dir>]
uip agent memory remove <name> [--folder-path <path>] [--path <dir>]

uip agent memory item add  <name> --memory-type episodic --feedback-id <id> [--folder-path <path> | --folder-key <key>] [--path <dir>]
uip agent memory item add  <name> --memory-type escalation --trace-id <id> --span-id <id> [--answer <text>] [--folder-path <path> | --folder-key <key>] [--path <dir>]
uip agent memory item list <name> [--memory-type <episodic|escalation>] [--folder-path <path> | --folder-key <key>] [--path <dir>]
uip agent memory add    <name> --memory-space <name> [--folder-path <path>] [--reference-key <key>] [--description <desc>] [--threshold <n>] [--result-count <n>] [--search-mode <hybrid|semantic>] [--field <name=weight>]... [--disable-dynamic-few-shot] [--path <dir>]
uip agent memory list   [--path <dir>]
uip agent memory remove <name> [--folder-path <path>] [--path <dir>]

uip agent memory item add  <name> --memory-type episodic --feedback-id <id> [--folder-path <path> | --folder-key <key>] [--path <dir>]
uip agent memory item add  <name> --memory-type escalation --trace-id <id> --span-id <id> [--answer <text>] [--folder-path <path> | --folder-key <key>] [--path <dir>]
uip agent memory item list <name> [--memory-type <episodic|escalation>] [--folder-path <path> | --folder-key <key>] [--path <dir>]

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.

adição de memória do agente uip​

Anexe um espaço de memória ao agente.

Argumentos​

  • <name> (necessário) — Nome da funcionalidade a ser usada no agente.

Opções​

BandeiraPadrãoRequiredFinalidade
--memory-space <name>—simNome do espaço de memória a ser anexado.
--folder-path <path>solution_folder dentro de uma soluçãofora de uma soluçãoCaminho da pasta onde existe o espaço de memória. Obrigatório quando o projeto do agente não está dentro de uma solução.
--reference-key <key>—Chave de recurso da solução de espaço da memória. Quando omitida, a chave é resolvida a partir da solução anexada.
--description <desc>—Descrição do espaço de memória.
--threshold <n>0Limite de pontuação de recuperação.
--result-count <n>3Número de resultados a serem recuperados (inteiro positivo).
--search-mode <mode>hybridhybrid ou semantic.
--field <name=weight>—Peso do campo de entrada. Repetível.
--disable-dynamic-few-shotdesativadaAnexe o espaço de memória sem habilitar a recuperação dinâmica de poucos exemplos (habilitado por padrão).
--path <path>.Caminho para o diretório do projeto do agente.

Recurso da solução​

Quando o projeto do agente está dentro de uma solução e --reference-key é omitido, memory add vincula a funcionalidade ao recurso de espaço de memória que a solução declara. Data.SolutionResource.Status relata o resultado:

StatusSignificado
NotInSolutionNenhuma solução inclui o projeto. Nada é declarado ou vinculado.
LinkedA solução já declara este espaço de memória. A funcionalidade carrega sua chave.
CreatedO espaço de memória está em solution_folder e a solução não o declarado. O comando declara-o na solução e vincula a funcionalidade.
NotDeclaredO espaço de memória está em uma pasta diferente de solution_folder e a solução não o declara. Instructions fornece o comando uip solution resources add --source remote para ser executado.
ProvidedA chave vem de --reference-key.

Se a escrita da funcionalidade falhar após o comando declarar o espaço de memória na solução, o comando removerá essa declaração novamente. Consulte recursos de solução uip para gerenciar recursos de solução diretamente.

Exemplos​

# Standalone agent project: --folder-path is required
uip agent memory add SupportRecall --memory-space customer-support-recall --folder-path Shared --path ./my-agent

# Inside a solution: declare the memory space as a solution resource and link it
uip agent memory add SupportRecall --memory-space customer-support-recall --path ./my-agent
# Standalone agent project: --folder-path is required
uip agent memory add SupportRecall --memory-space customer-support-recall --folder-path Shared --path ./my-agent

# Inside a solution: declare the memory space as a solution resource and link it
uip agent memory add SupportRecall --memory-space customer-support-recall --path ./my-agent

Formato dos dados (--output json)​

{
  "Code": "AgentMemoryAdd",
  "Data": {
    "Status": "Memory space added",
    "Name": "SupportRecall",
    "MemorySpace": "customer-support-recall",
    "FolderPath": "solution_folder",
    "DynamicFewShotEnabled": true,
    "Id": "a1b2c3d4-0000-0000-0000-000000000070",
    "ReferenceKey": "a1b2c3d4-0000-0000-0000-000000000071",
    "SolutionResource": {
      "Status": "Created",
      "Key": "a1b2c3d4-0000-0000-0000-000000000071",
      "Solution": "./MySolution/MySolution.uipx"
    }
  }
}
{
  "Code": "AgentMemoryAdd",
  "Data": {
    "Status": "Memory space added",
    "Name": "SupportRecall",
    "MemorySpace": "customer-support-recall",
    "FolderPath": "solution_folder",
    "DynamicFewShotEnabled": true,
    "Id": "a1b2c3d4-0000-0000-0000-000000000070",
    "ReferenceKey": "a1b2c3d4-0000-0000-0000-000000000071",
    "SolutionResource": {
      "Status": "Created",
      "Key": "a1b2c3d4-0000-0000-0000-000000000071",
      "Solution": "./MySolution/MySolution.uipx"
    }
  }
}

lista de memória de agentes uip​

Opções​

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

Exemplo​

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

Formato dos dados (--output json)​

{
  "Code": "AgentMemoryList",
  "Data": [
    { "Name": "SupportRecall", "MemorySpace": "customer-support-recall", "FolderPath": "Shared", "DynamicFewShotEnabled": true, "Id": "a1b2c3d4-0000-0000-0000-000000000070" }
  ]
}
{
  "Code": "AgentMemoryList",
  "Data": [
    { "Name": "SupportRecall", "MemorySpace": "customer-support-recall", "FolderPath": "Shared", "DynamicFewShotEnabled": true, "Id": "a1b2c3d4-0000-0000-0000-000000000070" }
  ]
}

remoção de memória do agente uip​

Argumentos​

  • <name> necessário) — Nome da funcionalidade, nome do espaço de memória ou ID a remover.

Opções​

BandeiraFinalidade
--folder-path <path>Caminho da pasta, ao remover por nome do espaço da memória.
--path <path>Caminho para o diretório do projeto do agente (padrão .).

Exemplo​

uip agent memory remove SupportRecall --path ./my-agent
uip agent memory remove SupportRecall --path ./my-agent

Formato dos dados (--output json)​

{ "Code": "AgentMemoryRemove", "Data": { "Status": "Memory space removed", "Name": "SupportRecall" } }
{ "Code": "AgentMemoryRemove", "Data": { "Status": "Memory space removed", "Name": "SupportRecall" } }

Um espaço de memória não encontrado por nome/ID falha no comando com um código de saída diferente de zero.

adição de item de memória do agente uip​

Promover uma execução de agente no espaço de memória do runtime. O tipo de item decide de quais dados de execução o item vem:

--memory-typeOrigemOpções obrigatórias
episodic (ou 0 )Feedback deixado no trace de uma execução. Crie-o com uip traces feedback create.--feedback-id
escalation (ou 1 )Um período de escalonamento que o agente gerou. Encontrar os IDs de trace e intervalo com uip traces spans get.--trace-id, --span-id

Argumentos​

  • <name> necessário) — Nome da funcionalidade, nome do espaço de memória ou ID.

Opções​

BandeiraRequiredFinalidade
--memory-type <type>simepisodic (0) ou escalation (1).
--feedback-id <id>para episodicFeedback a ser promovido.
--trace-id <id>para escalationTrace do período de escalonamento.
--span-id <id>para escalationPeríodo de escalonamento para armazenar.
--answer <text>Resposta armazenada com um item de escalonamento.
--folder-path <path>quando a pasta de funcionalidade está solution_folderA pasta do Orchestrator em que o espaço de memória está localizado no runtime. O padrão é a pasta da funcionalidade do agente.
--folder-key <key>Chave de pasta do Orchestrator, em vez de --folder-path.
--path <path>Caminho para o diretório do projeto do agente (padrão .).

Transmita --folder-path ou --folder-key, não ambos. Quando a funcionalidade apontar para solution_folder, passe a pasta na qual a solução está implantada; uip solution deploy list mostra.

Exemplos​

# Promote feedback on a run as an episodic item
uip agent memory item add SupportRecall --memory-type episodic --feedback-id 2f1e0c3a-0000-0000-0000-000000000010 --folder-path Shared/MySolution --path ./my-agent

# Store an escalation, with its answer, as an escalation item
uip agent memory item add SupportRecall --memory-type escalation --trace-id 3c4d5e6f-0000-0000-0000-000000000020 --span-id 4d5e6f70-0000-0000-0000-000000000021 --answer "Refund within 14 days" --folder-key 5c1eab29-0000-0000-0000-000000000030 --path ./my-agent
# Promote feedback on a run as an episodic item
uip agent memory item add SupportRecall --memory-type episodic --feedback-id 2f1e0c3a-0000-0000-0000-000000000010 --folder-path Shared/MySolution --path ./my-agent

# Store an escalation, with its answer, as an escalation item
uip agent memory item add SupportRecall --memory-type escalation --trace-id 3c4d5e6f-0000-0000-0000-000000000020 --span-id 4d5e6f70-0000-0000-0000-000000000021 --answer "Refund within 14 days" --folder-key 5c1eab29-0000-0000-0000-000000000030 --path ./my-agent

Formato dos dados (--output json)​

{
  "Code": "AgentMemoryItemAdd",
  "Data": {
    "Status": "Memory item added",
    "Memory": "SupportRecall",
    "MemorySpace": "customer-support-recall",
    "MemorySpaceId": "a1b2c3d4-0000-0000-0000-000000000090",
    "FolderPath": "Shared/MySolution",
    "FolderKey": "5c1eab29-0000-0000-0000-000000000030",
    "MemoryType": 0,
    "FeedbackId": "2f1e0c3a-0000-0000-0000-000000000010",
    "TraceId": null,
    "SpanId": null,
    "Id": "a1b2c3d4-0000-0000-0000-000000000080"
  }
}
{
  "Code": "AgentMemoryItemAdd",
  "Data": {
    "Status": "Memory item added",
    "Memory": "SupportRecall",
    "MemorySpace": "customer-support-recall",
    "MemorySpaceId": "a1b2c3d4-0000-0000-0000-000000000090",
    "FolderPath": "Shared/MySolution",
    "FolderKey": "5c1eab29-0000-0000-0000-000000000030",
    "MemoryType": 0,
    "FeedbackId": "2f1e0c3a-0000-0000-0000-000000000010",
    "TraceId": null,
    "SpanId": null,
    "Id": "a1b2c3d4-0000-0000-0000-000000000080"
  }
}

Para um item de escalonamento, FeedbackId é null, e TraceId e SpanId carregam os valores passados.

lista de itens de memória do agente uip​

Liste os itens que o espaço de memória do runtime contém, na pasta na qual a solução é implantada.

Argumentos​

  • <name> necessário) — Nome da funcionalidade, nome do espaço de memória ou ID.

Opções​

BandeiraFinalidade
--memory-type <type>Apenas itens deste tipo: episodic (0) ou escalation (1).
--folder-path <path>A pasta do Orchestrator em que o espaço de memória está localizado no runtime. O padrão é a pasta da funcionalidade do agente; necessário quando essa pasta está solution_folder.
--folder-key <key>Chave de pasta do Orchestrator, em vez de --folder-path.
--path <path>Caminho para o diretório do projeto do agente (padrão .).

Exemplo​

uip agent memory item list SupportRecall --folder-path Shared/MySolution --path ./my-agent
uip agent memory item list SupportRecall --folder-path Shared/MySolution --path ./my-agent

Formato dos dados (--output json)​

{
  "Code": "AgentMemoryItemList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000080",
      "MemoryType": 0,
      "Status": 0,
      "FeedbackId": "2f1e0c3a-0000-0000-0000-000000000010",
      "TraceId": null,
      "SpanId": null,
      "AgentId": "a1b2c3d4-0000-0000-0000-000000000001",
      "UserEmail": "jane.doe@example.com",
      "UpdateTime": "2026-09-29T14:00:00.000Z"
    }
  ]
}
{
  "Code": "AgentMemoryItemList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000080",
      "MemoryType": 0,
      "Status": 0,
      "FeedbackId": "2f1e0c3a-0000-0000-0000-000000000010",
      "TraceId": null,
      "SpanId": null,
      "AgentId": "a1b2c3d4-0000-0000-0000-000000000001",
      "UserEmail": "jane.doe@example.com",
      "UpdateTime": "2026-09-29T14:00:00.000Z"
    }
  ]
}
  • uip agent validate — executar novamente após editar a configuração de memória.
  • uip agent refresh — regenera arquivos derivados após um espaço de memória ser adicionado.

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