Incorporação de IFrame e Apps

Visão geral

Incorpore seu agente de conversa a aplicativos da Web usando o iFrame. Use essa 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 a aplicativos da Web personalizados ou ao UiPath Apps.

Disponibilidade de funcionalidades

Recurso	Disponível
Iniciar novo chat	✅
Histórico do chat	✅
Excluir sessão do chat	✅
Configurações	✅
Iniciando prompts	✅
Carregamentos de arquivo	✅
Citações	❌
Visualização do HTML	✅
Copiar resposta	✅
Feedback ( gostei)	✅
Debug dump	❌

Pré-requisitos

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

Configuração do administrador ou desenvolvedor

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

Encontrar 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 da 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.
• Umusuário anônimo deve ter acesso ao aplicativo ou superfície onde o agente está incorporado.

Incorporando o 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:

O nome da organização e do tenant diferenciam maiúsculas de 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 com trilho à direita, 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 para a tela de boas-vindas de primeira execução
welcomeDescription	Não	Descrição da tela de boas-vindas de primeira execução
suggestions	Não	Matriz de prompts sugeridos para primeira execução
showHistory	Não	Mostrar/ocultar painel de histórico do chat (padrão: true)

Exemplo 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 no UiPath Apps

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

1. Abra seu aplicativo no UiPath Apps Studio.

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

3. Defina a propriedade Origem do iFrame como a URL construída.

4. Publique o Aplicativo.

   

Ao incorporar um agente de conversa ao UiPath Apps, use aspas duplas para escapar da matriz de sugestões, 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 da Web que suporte 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 de uipath.com.
• Design responsivo: configure valores de largura e altura apropriados para garantir a renderização adequada em todos os tamanhos de tela.
• Acesso à área de transferência: inclua allow="clipboard-write" para habilitar a funcionalidade de cópia de resposta.

Funcionalidades do chat

A experiência de chat incorporado usa a interface gráfica do chat de gerenciamento de instâncias , fornecendo a mesma funcionalidade de chat, com as seguintes exceções e limitações.

Limitações

As seguintes funcionalidades não estão disponíveis no modo incorporado:

Recurso	Observações
Citações	A visualização da citação não está disponível
Debug dump	Não disponível. Use o Gerenciamento de Instâncias para depuração.

Opções de autenticação

Usuários autenticados

Para usuários internos com contas da UiPath:

• Os usuários se autenticam 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.
• É necessário um endpoint do token hospedado pela sua organização.
• Nenhuma licença individual de usuário é 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 enfaticamente bloquear agentes anônimos atrás do seu próprio portal ou login para mitigar o abuso.

Solução de problemas

iFrame não está carregando

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

Cópia não está funcionando

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

Próximas Etapas

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