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.

trocas de conversação uipath, mensagens, truncamentos, configurações de usuários

Sintaxe e opções para histórico de conversas e feedback (exchanges, mensagens), roteamento de canal de voz (trunks) e configurações de perfil (user-configurações) em "uip conversacional".

Parte da ferramenta uip conversational . Esta página abrange quatro grupos de comando: trocas e mensagens leem o histórico de uma conversa e permitem que você classifique trocas; truncar os números de telefone SIP dos quais um agente de conversa habilitado por voz responde ou disca; user-settings gerencia o perfil de conversa do usuário atual. Nenhum deles cria ou direciona uma conversa — consulte a página principal para chat, agents e conversations.

Conceitos​

  • Exchange — uma viagem de ida e volta de solicitação/resposta dentro de uma conversa: uma mensagem do usuário de entrada, uma mensagem do assistente (com partes de conteúdo, chamadas de ferramentas, citações) de saída. chat (na página pai) direciona trocas ativas; os verbos exchanges/messages desta página as leem novamente posteriormente.
  • Mensagem → parte de conteúdo — uma mensagem é um contêiner para uma ou mais partes de conteúdo (partes de texto/ markdown, registros de chamada de ferramenta). messages get-content-part busca uma parte diretamente; se a pesquisa direta falhar, a CLI retornará para buscar a mensagem pai e pesquisar sua contentParts matriz antes de parar.
  • Truncar — um número de telefone SIP conectado no Gerenciamento de instâncias em Números de telefone. Os truncamentos habilitados para saída são marcados pelo método "Criar chamada de saída" de um fluxo de voz; atividade; Os truncados para entrada roteiam as chamadas de entrada para uma versão de processo de fluxo publicada por meio trunks assign de.

Resumo​

uip conversational exchanges list <conversation-id> [--limit <n>] [--exchange-sort <order>] [--message-sort <order>] [--cursor <token>]
uip conversational exchanges get <conversation-id> <exchange-id> [--message-sort <order>]
uip conversational exchanges feedback <conversation-id> <exchange-id> --rating positive|negative [--comment <text>]
uip conversational messages get <conversation-id> <exchange-id> <message-id>
uip conversational messages get-content-part <conversation-id> <exchange-id> <message-id> <content-part-id>
uip conversational trunks list [--direction inbound|outbound]
uip conversational trunks assign <trunk> [--process-key <key> --folder-key <key> [--entry-point <id>] | --clear] [-y]
uip conversational user-settings get
uip conversational user-settings update [--name <name>] [--email <email>] [--role <role>] [--department <department>] [--company <company>] [--country <country>] [--timezone <timezone>]
uip conversational exchanges list <conversation-id> [--limit <n>] [--exchange-sort <order>] [--message-sort <order>] [--cursor <token>]
uip conversational exchanges get <conversation-id> <exchange-id> [--message-sort <order>]
uip conversational exchanges feedback <conversation-id> <exchange-id> --rating positive|negative [--comment <text>]
uip conversational messages get <conversation-id> <exchange-id> <message-id>
uip conversational messages get-content-part <conversation-id> <exchange-id> <message-id> <content-part-id>
uip conversational trunks list [--direction inbound|outbound]
uip conversational trunks assign <trunk> [--process-key <key> --folder-key <key> [--entry-point <id>] | --clear] [-y]
uip conversational user-settings get
uip conversational user-settings update [--name <name>] [--email <email>] [--role <role>] [--department <department>] [--company <company>] [--country <country>] [--timezone <timezone>]

trocas de conversação da UIP​

Recuperar e fornecer feedback sobre trocas de conversa.

lista de trocas conversacionais do uip​

Argumentos​
NameRequiredFinalidade
<conversation-id>simUUID da conversa.
Opções​
LongValorDescription
--limit <number>número inteiro positivoTrocas por página.
--exchange-sort <order>ascending|descendingOrdem de classificação das trocas.
--message-sort <order>ascending|descendingOrdem de classificação das mensagens em cada troca.
--cursor <token>StringCursor de paginação para a próxima página.
Exemplo​
uip conversational exchanges list b2c3d4e5-0000-0000-0000-000000000001 --limit 20
uip conversational exchanges list b2c3d4e5-0000-0000-0000-000000000001 --limit 20
Formato dos dados (--output json)​
{
  "Result": "Success",
  "Code": "ExchangeList",
  "Data": {
    "items": [{ "id": "e1e2e3e4-0000-0000-0000-000000000001", "...": "raw exchange record" }],
    "nextCursor": null
  }
}
{
  "Result": "Success",
  "Code": "ExchangeList",
  "Data": {
    "items": [{ "id": "e1e2e3e4-0000-0000-0000-000000000001", "...": "raw exchange record" }],
    "nextCursor": null
  }
}

trocas de conversação uip obter​

Argumentos​
NameRequiredFinalidade
<conversation-id>simUUID da conversa.
<exchange-id>simUUID do Exchange.
Opções​
LongValorDescription
--message-sort <order>ascending|descendingOrdem de classificação das mensagens na troca retornada.
Exemplo​
uip conversational exchanges get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001
uip conversational exchanges get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001
Formato dos dados (--output json)​
{ "Result": "Success", "Code": "Exchange", "Data": { "id": "e1e2e3e4-0000-0000-0000-000000000001", "messages": [] } }
{ "Result": "Success", "Code": "Exchange", "Data": { "id": "e1e2e3e4-0000-0000-0000-000000000001", "messages": [] } }

feedback de trocas de conversação do uip​

Argumentos​
NameRequiredFinalidade
<conversation-id>simUUID da conversa.
<exchange-id>simUUID do Exchange.
Opções​
LongValorRequiredDescription
--rating <rating>positive|negativesimClassificação de feedback. Qualquer outro valor falha no lado do cliente antes de qualquer chamada de rede.
--comment <comment>StringnãoComentário de feedback opcional.
Exemplo​
uip conversational exchanges feedback b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 --rating positive --comment "Resolved quickly"
uip conversational exchanges feedback b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 --rating positive --comment "Resolved quickly"
Formato dos dados (--output json)​
{ "Result": "Success", "Code": "FeedbackCreated", "Data": { "rating": "positive", "comment": "Resolved quickly" } }
{ "Result": "Success", "Code": "FeedbackCreated", "Data": { "rating": "positive", "comment": "Resolved quickly" } }

mensagens de conversação do UIP​

Recupera mensagens de conversa e suas partes de conteúdo.

mensagens de conversação uip obter​

Argumentos​
NameRequiredFinalidade
<conversation-id>simUUID da conversa.
<exchange-id>simUUID do Exchange.
<message-id>simUUID da mensagem.
Exemplo​
uip conversational messages get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001
uip conversational messages get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001
Formato dos dados (--output json)​
{ "Result": "Success", "Code": "Message", "Data": { "id": "f1f2f3f4-0000-0000-0000-000000000001", "contentParts": [] } }
{ "Result": "Success", "Code": "Message", "Data": { "id": "f1f2f3f4-0000-0000-0000-000000000001", "contentParts": [] } }

mensagens de conversação uip get-content-part​

Argumentos​
NameRequiredFinalidade
<conversation-id>simUUID da conversa.
<exchange-id>simUUID do Exchange.
<message-id>simUUID da mensagem.
<content-part-id>simUUID da parte do conteúdo.

Se a pesquisa direta de parte do conteúdo falhar, a CLI tenta novamente automaticamente buscar a mensagem pai e pesquisar sua matriz contentParts por um id ou contentPartId correspondente antes de relatar um erro.

Exemplo​
uip conversational messages get-content-part b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001 a1a2a3a4-0000-0000-0000-000000000001
uip conversational messages get-content-part b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001 a1a2a3a4-0000-0000-0000-000000000001
Formato dos dados (--output json)​
{ "Result": "Success", "Code": "ContentPart", "Data": { "id": "a1a2a3a4-0000-0000-0000-000000000001", "isText": true, "data": "..." } }
{ "Result": "Success", "Code": "ContentPart", "Data": { "id": "a1a2a3a4-0000-0000-0000-000000000001", "isText": true, "data": "..." } }

Trabalhos de conversação do UIP​

Inspecione e encaminhe os logs SIP (números de telefone) do tenant configurados para voz conversacional.

lista de troncos de conversação uip​

Opções​
LongValorDescription
--direction <direction>inbound|outboundApenas trilhos habilitados para esta direção de chamada. Omita para listar cada tronco. Qualquer outro valor falha no lado do cliente.
Exemplo​
uip conversational trunks list --direction inbound
uip conversational trunks list --direction inbound
Formato dos dados (--output json)​
{
  "Result": "Success",
  "Code": "SipTrunkList",
  "Data": [
    { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "inboundEnabled": true, "outboundEnabled": false, "processKey": null }
  ]
}
{
  "Result": "Success",
  "Code": "SipTrunkList",
  "Data": [
    { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "inboundEnabled": true, "outboundEnabled": false, "processKey": null }
  ]
}

atribuição de logs de conversação do uip​

Roteie as chamadas de entrada de um truncamento para uma versão de processo de fluxo publicada ou limpe o roteamento com --clear. O processo deve ser uma versão de fluxo implantada cujo fluxo começa a partir de um gatilho de chamada de entrada ; quando o fluxo tem exatamente um desses gatilhos, --entry-point pode ser omitido e é resolvido automaticamente — quando tem mais de um, --entry-point é necessário e o comando falha listando os IDs válidos.

Argumentos​
NameRequiredFinalidade
<trunk>simID do tronco (GUID) ou seu número de telefone no formulário E.164 (por exemplo +18334815468).
Opções​
LongValorDescription
--process-key <key>GUIDChave de versão do Orchestrator do processo de fluxo implantado (uip or processes list mostra como Key). Obrigatório, a menos que --clear.
--folder-key <key>GUIDChave da pasta do Orchestrator em que a versão está localizada. Obrigatório, a menos que --clear.
--entry-point <id>StringID do ponto de entrada da chamada de entrada dentro do pacote de fluxo. Resolvido automaticamente quando o fluxo tem exatamente um; exigido (e validado com pontos de entrada reais da versão), caso contrário.
--clearBandeiraRemova o roteamento do processo de entrada do tronco. mutuamente exclusivo com --process-key/--folder-key/--entry-point — a combinação dos dois falha no lado do cliente.
-y, --yesBandeiraConfirme o reencaminhamento ou limpe um truncamento que já tem roteamento de entrada. Necessário nesse caso — a CLI nunca solicita.

Ordem de validação: --clear versus o par processo/pasta é verificado primeiro; então, o truncamento deve, na verdade, ser inboundEnabled (uma tentativa de roteamento em um truncamento somente de saída falha, apontando trunks list --direction inbound para); então, se o tronco já tiver uma associação, -y é necessário; então, os pontos de entrada reais de chamadas de entrada da versão são listados na plataforma e validados em relação a --entry-point (ou resolvidos automaticamente) antes que a associação seja escrita — a gravação é tudo ou nada.

Exemplos​
# Auto-resolve the entry point (release has exactly one Incoming call trigger)
uip conversational trunks assign +18334815468 --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --folder-key a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e

# Clear inbound routing on a bound trunk
uip conversational trunks assign +18334815468 --clear -y
# Auto-resolve the entry point (release has exactly one Incoming call trigger)
uip conversational trunks assign +18334815468 --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --folder-key a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e

# Clear inbound routing on a bound trunk
uip conversational trunks assign +18334815468 --clear -y
Formato dos dados (--output json)​
{
  "Result": "Success",
  "Code": "SipTrunkAssign",
  "Data": { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "processKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09", "folderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e", "entryPoint": "..." }
}
{
  "Result": "Success",
  "Code": "SipTrunkAssign",
  "Data": { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "processKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09", "folderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e", "entryPoint": "..." }
}

--clear grava { processKey: null, folderKey: null, entryPoint: null }.

usuário-configuração de conversação do uip​

Gerencie as configurações do perfil de conversa do usuário atual.

uip conversacional user-settings obter​

Sem opções além das globais.

Exemplo​
uip conversational user-settings get
uip conversational user-settings get
Formato dos dados (--output json)​
{
  "Result": "Success",
  "Code": "UserSettings",
  "Data": { "name": "Jane Doe", "email": "jane@example.com", "role": "Support Lead", "department": "Support", "company": "Acme", "country": "US", "timezone": "America/New_York" }
}
{
  "Result": "Success",
  "Code": "UserSettings",
  "Data": { "name": "Jane Doe", "email": "jane@example.com", "role": "Support Lead", "department": "Support", "company": "Acme", "country": "US", "timezone": "America/New_York" }
}

atualização das configurações do usuário conversacional do uip​

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

Opções​
LongValorDescription
--name <name>StringNome do usuário.
--email <email>Stringendereço de e-mail.
--role <role>StringFunção do usuário.
--department <department>StringDepartamento.
--company <company>StringEmpresa.
--country <country>StringPaís.
--timezone <timezone>StringFuso horário.
Exemplo​
uip conversational user-settings update --timezone "America/Los_Angeles"
uip conversational user-settings update --timezone "America/Los_Angeles"
Formato dos dados (--output json)​

Mesmo formato da resposta de get, Code: "UserSettingsUpdated".

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