UIP de conversação

Sintaxe e opções para a conversação "uip", que conversa com agentes de conversa da UiPath implantados e gerencia as conversas resultantes — chat, agentes e conversas.

uip conversational interage com agentes de conversa implantados — processos implantados pelo Orchestrator expostos como uma interface de chat, criados no runtime de agente de conversação da UiPath. Esta página abrange a descoberta de versões de agentes (agents), o início/gerenciamento das conversas que você tem com eles (conversations) e o chat em tempo real (chat). Para histórico de conversas, feedback, roteamento de canais de voz e configurações de perfil, consulte Conversacional: trocas, mensagens, truncamentos e configurações de usuários.

Conceitos

• Versão de agente — uma versão de processo do Orchestrator implantada que tem a capacidade de conversação habilitada, identificada por um ID de versão mais a pasta em que está localizada. Descubra versões com agents list.
• Conversa — uma sessão persistente contra uma versão do agente, criada com conversations create, identificada por um UUID. Toda a atividade de chat acontece dentro de uma conversa.
• Chat versus conversas — conversations create/list/get gerenciam o próprio registro de conversa (metadados, rótulo, entrada do agente); chat é a interação ao vivo e em tempo real com uma conversa existente — você cria uma conversa primeiro, depois chat nela.
• --agent-input em conversations create/update é uma string JSON que gera ou atualiza a entrada inicial do agente para a conversa; ele é envolvido como { inline: <parsed JSON> } antes de ser enviado.

Resumo

uip conversational chat <conversation-id> [-m, --message <text>]
uip conversational agents list [--folder-id <id>]
uip conversational agents get --release-id <id> --folder-id <id>
uip conversational conversations create --release-id <id> --folder-id <id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations list [--limit <n>] [--sort-order <order>] [--cursor <token>] [--agent-id <id>] [--agent-key <guid>] [--label <substring>]
uip conversational conversations get <conversation-id>
uip conversational conversations update <conversation-id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations delete <conversation-id> -y
uip conversational conversations attachments upload <conversation-id> --file <path>
uip conversational conversations attachments get-uri <conversation-id> --file-name <name>

chat de conversação uipath

Interagir com uma conversa existente em tempo real — seja uma mensagem única (--message) ou um REPL interativo (omitir --message).

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	UUID da conversa (de conversations create/list).

Opções

Long	Valor	Description
-m, --message <text>	String	Envie uma única mensagem e saia após a conclusão da troca (não interativo). Omita para iniciar o REPL interativo.

Sem --message, chat requer um terminal com capacidade de solicitação — falha rapidamente em um ambiente não interativo (CI, saída tabulada) com instruções para usar --message em vez disso. No REPL, digite /exit ou /quit para encerrar a sessão ou pressione Ctrl+C. As respostas do Assistant são transmitidas para o stdout token por token; marcadores de citação embutidas ([1], [2],...) renderizados como os fluxos de resposta e um bloco de nota de rodapé --- Citations --- com títulos/URLs impressos após a conclusão de cada troca, desduplicado ao longo da sessão.

Exemplos

# Single-shot message
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001 --message "What's the status of order 4471?"

# Interactive REPL
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001

Esse comando transmite texto legível por humanos para o stdout em vez de emitir o envelope habitual da CLI --output json — ele é projetado para uso interativo, não para scripts. Um erro de inicialização ou no meio da sessão ainda é relatado por meio do envelope padrão OutputFormatter.error antes que o processo saia de um número diferente de zero.

agentes de conversação da UIP

Inspecione as versões do agente de conversa.

lista de agentes de conversação uip

Opções

Long	Valor	Description
--folder-id <id>	número inteiro positivo	Filtra os agentes de conversa por pasta.

Exemplo

uip conversational agents list --folder-id 123456

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationalAgentList",
  "Data": [
    {
      "id": 42,
      "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
      "name": "Support Assistant",
      "description": "Handles tier-1 support conversations",
      "processVersion": "1.0.0",
      "processKey": "SupportAssistant",
      "folderId": 123456,
      "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
      "createdTime": "2026-08-01T10:00:00Z"
    }
  ]
}

As chaves são mantidas em CamelCase nativo (preserveDataKeys: true), não em PascalCased.

agentes de conversação do uip obter

Opções

Long	Valor	Required	Description
--release-id <id>	número inteiro positivo	sim	ID de versão do agente.
--folder-id <id>	número inteiro positivo	sim	ID da pasta que contém o agente.

Exemplo

uip conversational agents get --release-id 42 --folder-id 123456

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationalAgent",
  "Data": {
    "id": 42,
    "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "name": "Support Assistant",
    "description": "Handles tier-1 support conversations",
    "processVersion": "1.0.0",
    "processKey": "SupportAssistant",
    "folderId": 123456,
    "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
    "createdTime": "2026-08-01T10:00:00Z",
    "appearance": { "...": "agent chat-widget appearance config" }
  }
}

appearance é o campo get retorna além do que list já mostra.

conversas de conversação da uip

Crie, liste, inspecione, atualize e exclua conversas, além de gerenciar seus anexos de arquivos.

conversas de conversação do uip criar

Opções

Long	Valor	Required	Description
--release-id <id>	número inteiro positivo	sim	ID de uma versão habilitada para conversação.
--folder-id <id>	número inteiro positivo	sim	ID da pasta que contém a versão.
--label <label>	String	não	Rótulo da conversa.
--autogenerate-label	Bandeira	não	Habilitar a geração automática de rótulos após ocorrerem as trocas.
--no-autogenerate-label	Bandeira	não	Desabilitar a geração automática de rótulo.
--agent-input <json>	String JSON	não	Entrada inicial para o agente — analisada e envolvida como { inline: <value> }. Falha rápida em JSON inválido.

Exemplo

uip conversational conversations create --release-id 42 --folder-id 123456 --label "Order 4471"

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationCreated",
  "Data": {
    "id": "b2c3d4e5-0000-0000-0000-000000000001",
    "label": "Order 4471",
    "autogenerateLabel": false,
    "agentId": 42,
    "folderId": 123456,
    "agentInput": { "inline": {} },
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "spanId": "e5f6a7b8",
    "createdTime": "2026-08-01T10:00:00Z",
    "lastActivityTime": "2026-08-01T10:00:00Z"
  }
}

conversação conversacional lista de conversas

Opções

Long	Valor	Description
--limit <number>	número inteiro positivo	Conversas por página.
--sort-order <order>	ascending|descending	Ordem de classificação.
--cursor <token>	String	Cursor de paginação para a próxima página.
--agent-id <id>	número inteiro positivo	Filtrar por ID de versão do agente.
--agent-key <guid>	String	Filtrar por chave de versão do agente.
--label <substring>	String	Filtrar por substring de rótulo, sem diferenciação entre maiúsculas e minúsculas, 1 a 100 caracteres.

Exemplo

uip conversational conversations list --agent-id 42 --limit 20

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationList",
  "Data": {
    "items": [{ "id": "b2c3d4e5-0000-0000-0000-000000000001", "label": "Order 4471" }],
    "nextCursor": null
  }
}

conversas de conversação uip obter

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	UUID da conversa.

Exemplo

uip conversational conversations get b2c3d4e5-0000-0000-0000-000000000001

Formato dos dados (--output json)

Mesmo formato da resposta de create, Code: "Conversation".

atualização de conversas da conversação uip

Pelo menos uma opção é necessária — omitir todas as quatro falhas do lado do cliente antes de qualquer chamada de rede.

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	UUID da conversa.

Opções

Long	Valor	Description
--label <label>	String	Novo rótulo da conversa.
--autogenerate-label	Bandeira	Habilitar a geração automática de rótulos.
--no-autogenerate-label	Bandeira	Desabilitar a geração automática de rótulo.
--agent-input <json>	String JSON	Entrada de agente atualizada — substitui o valor inteiro, envolvido como { inline: <value> }.

Exemplo

uip conversational conversations update b2c3d4e5-0000-0000-0000-000000000001 --label "Order 4471 (resolved)"

Formato dos dados (--output json)

Mesmo formato da resposta de create, Code: "ConversationUpdated".

conversas de conversação uip excluir

Destrutivo — requer -y/--yes; a CLI nunca solicita.

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	UUID da conversa.

Opções

Long	Description
-y, --yes	Confirme esta operação irreversível. Obrigatório — a omiti-la falha antes de qualquer chamada de rede.

Exemplo

uip conversational conversations delete b2c3d4e5-0000-0000-0000-000000000001 -y

Formato dos dados (--output json)

Mesmo formato da resposta de create, Code: "ConversationDeleted" — o último estado conhecido da conversa excluída.

upload de anexos de conversas da conversação uip

Carregue um arquivo local como um anexo de conversa.

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	UUID da conversa.

Opções

Long	Valor	Required	Description
--file <path>	Path	sim	Caminho para o arquivo local a ser carregado.

Exemplo

uip conversational conversations attachments upload b2c3d4e5-0000-0000-0000-000000000001 --file ./invoice.pdf

Formato dos dados (--output json)

{ "Result": "Success", "Code": "AttachmentUploaded", "Data": { "...": "raw upload result from the conversational-agent SDK" } }

anexos de conversas uip get-uri

Obtenha um URI de upload pré-assinado para um anexo, sem carregar um arquivo local (para uploads fora de faixa).

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	UUID da conversa.

Opções

Long	Valor	Required	Description
--file-name <name>	String	sim	Nome do arquivo que o URI aceitará.

Exemplo

uip conversational conversations attachments get-uri b2c3d4e5-0000-0000-0000-000000000001 --file-name invoice.pdf

Formato dos dados (--output json)

{ "Result": "Success", "Code": "AttachmentUri", "Data": { "...": "pre-signed URI payload" } }

Relacionado

• Conversacional: trocas, mensagens, truncamentos e configurações do usuário — histórico de conversas, feedback, roteamento de canais de voz e configurações de perfil.

Veja também

• Opções globais
• Códigos de saída