Incorporação de IFrame e Apps

Incorpore um agente de chat em aplicativos Web ou UiPath Apps usando o iFrame para uma experiência de chat perfeita no aplicativo.

Visão geral

Incorpore seu agente de conversa baseado em chat em aplicativos Web usando o iFrame. Use esta abordagem para adicionar agentes de conversa a aplicativos de terceiros ou ao UiPath Apps usando o componente iFrame.

Usuários pretendidos: desenvolvedores e administradores que desejam incorporar agentes de conversa em aplicativos Web personalizados ou UiPath Apps.

Disponibilidade de funcionalidades

Recurso	Disponível
Iniciar novo chat	✅
Histórico do chat	✅
Excluir sessão de chat	✅
Configurações do perfil do usuário	✅
Iniciando prompts	✅
Carregamentos de arquivo	✅
Entradas de conversas*	✅
Confirmações de chamadas de ferramentas	✅
Citações	✅
Visualização do HTML	✅
Copiar resposta	✅
Feedback (polegares)	✅

* As entradas de conversa são compatíveis apenas com Agentes de conversa criados no Agent Builder.

Pré-requisitos

Para incorporar um agente de conversa, execute as seguintes etapas de configuração:

Configuração de administrador ou desenvolvedor

1. Publique o agente de conversa na pasta do Orchestrator desejada.
2. Recupere o ID de versão do agente no Gerenciamento de instâncias.
3. Para UiPath Apps, crie um projeto do Apps em UiPath Studio.
4. Para Apps de terceiros, certifique-se de que o aplicativo da Web seja compatível com a incorporação do iFrame.

Localizar o ID do agente

1. Em Gerenciamento de instâncias, navegue até Agentes > Agentes implantados.
2. Selecione Chat para o agente desejado.
3. Copie o ID do agente do URL. Por exemplo, no URL https://cloud.uipath.com/conversationalagents/agents_/deployed/chat/342061, o ID do agente é 342061.

Requisitos do usuário

• Os usuários autenticados devem ter uma conta da UiPath com permissão para acessar o agente.
• Os usuários anônimos devem ter acesso ao Aplicativo ou superfície onde o agente está incorporado.

Incorporação do agente

Construção de URL

Defina a origem do iFrame como uma URL com o seguinte formato:

https://cloud.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=<mode>

Observação:

A organização e o nome do tenant são sensíveis a maiúsculas e minúsculas.

Parâmetros de URL

Parâmetro	Required	Description
agentId	Sim	O ID de versão do agente publicado
mode	Não	embedded para experiência de trilho direito, fullscreen para tela cheia (padrão: fullscreen)
title	Não	Título exibido no cabeçalho do chat (padrão: nome do agente)
welcomeTitle	Não	Título da tela de boas-vindas da primeira execução
welcomeDescription	Não	Descrição da tela de boas-vindas da primeira execução
suggestions	Não	Array de solicitações sugeridas para a primeira execução
showHistory	Não	Mostrar/ocultar o painel de histórico do chat (padrão: true)

Exemplos de URLs

Modo incorporado básico

https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded

Com mensagem de boas-vindas e sugestões

https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded&title=HR Assistant&welcomeTitle=Welcome!&welcomeDescription=I can help you with HR questions&suggestions=["What is the PTO policy?","How do I submit expenses?"]

Incorporação em UiPath Apps

Para incorporar um agente de conversa no UiPath Apps, use o componente iFrame.

1. Abra seu App no UiPath Apps Studio.

2. Adicione um componente iFrame à sua página.

3. Defina a propriedade origem do iFrame para o URL construído.

4. Publique o Aplicativo.

   

Ao incorporar um agente de conversa no UiPath Apps, escape da Array de sugestões usando aspas duplas, conforme mostrado no exemplo a seguir:

suggestions=[""What is the PTO policy?"",""How do I submit expenses?""]

Isso é necessário porque o UiPath Apps valida o valor como uma string.

Incorporação em aplicativos de terceiros

Você pode incorporar um agente de conversa em qualquer aplicativo web que seja compatível com a incorporação de iFrame.

Exemplo de HTML

<iframe
  src="https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded"
  width="400"
  height="600"
  frameborder="0"
  allow="clipboard-write"
></iframe>

Considerações

• Políticas de origem cruzada: certifique-se de que a Política de Segurança de Conteúdo do seu aplicativo permita a incorporação a partir de uipath.com.
• Design responsivo: configure valores de largura e altura apropriados para garantir a renderização adequada em tamanhos de tela.
• Acesso à área de transferência: inclua allow="clipboard-write" para habilitar a funcionalidade de resposta de cópia.

Funcionalidades do chat

A experiência de chat incorporada usa a UI do chat de Gerenciamento de instâncias, fornecendo a mesma funcionalidade do chat.

Opções de autenticação

Usuários autenticados

Para usuários internos com contas da UiPath:

• Os usuários autenticam-se usando a autenticação padrão da UiPath.
• O agente tem acesso às informações de identidade do usuário, como nome e endereço de email.
• O consumo é rastreado em relação à licença do usuário.

Usuários anônimos

Para cenários externos ou não autenticados:

• Um aplicativo externo confidencial deve ser configurado no portal do administrador.
• Um ponto de extremidade do token hospedado por sua organização é necessário.
• Nenhuma licença de usuário individual é necessária.
• O consumo é deduzido do pool de unidades do tenant.

Para obter instruções de configuração, consulte Configuração de acesso anônimo.

Para obter detalhes de licenciamento, consulte Licenciamento.

AVISO:

O acesso anônimo permite que usuários sem contas da UiPath interajam com seu agente. Recomendamos fortemente a colocação de agentes anônimos por trás do seu próprio portal ou login para mitigar abusos.

Solução de problemas

iFrame não está sendo carregado

• Verifique se o URL está construído corretamente.
• Verifique se o ID do agente é válido.
• Certifique-se de que o agente esteja publicado e em execução.
• Verifique o console do navegador em busca de erros de Política de Segurança de Conteúdo.

Copiar não está funcionando

• Certifique-se de que o iFrame inclua o atributo allow="clipboard-write".
• Verifique as permissões do navegador quanto ao acesso à área de transferência.

Próximas Etapas

• Configuração de acesso anônimo: habilitar o acesso para usuários sem contas da UiPath
• Gerenciamento de instâncias: referência de funcionalidade completa e depuração