Incorporar agentes de conversa

Incorpore um agente de conversa publicado em um UiPath App ou aplicativo de terceiros usando um controle IFrame no Studio Web.

You can embed a conversational agent directly inside a UiPath App or any third-party application using an IFrame. This allows users to interact with agents without leaving the application.

Incorporação de agentes de conversação no UiPath Apps

1. Crie e publique um agente de conversa.

2. Open your app project in Studio.

3. Add an IFrame component to your page.

4. Defina o URL de origem do IFrame usando o seguinte formato:

   "https://<cloud_env>.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=embedded&title=<title>&welcomeTitle=<welcome_title>&welcomeDescription=<welcome_description>&suggestions=<suggestions>"
   

   Importante:

   A organização e o tenant podem ser o ID do agente ou o nomedo agente

   Parâmetros obrigatórios

   • agentId: Release ID of the published conversational agent.

   Parâmetros opcionais

   • mode - Pode ser embedded ou fullscreen (o valor padrão é fullscreen).
   • título - O título do componente do chat. O padrão é o nome do Agente.
   • TítuloDeboasvindas - Título da experiência da primeira execução exibido no meio da tela. O padrão é uma string vazia ''.
   • inviteDescription - Descrição da experiência da primeira execução. O padrão é uma string vazia ''.
   • sugestões - Sugestões de primeira execução. O padrão é uma matriz vazia []. Exemplo: ["Hi, what can you do", "Hello, how are you"].
     Observação:

     Para testar no navegador diretamente, envolva em um conjunto de aspas duplas. Para a incorporação de aplicativos, envolva dois conjuntos de aspas duplas.

   • mostrar Histórico - Exibe o painel Histórico. O padrão é true.
   • jobStartOverride — substitui os trabalhos do agente de conversa que são executados ao servir a conversa. Quando não for passado ou quando runAsMe estiver indefinido, o SAS executará o trabalho com as configurações padrão de início de trabalho RunAsMe: false. Exemplo: jobStartOverrides={"runAsMe":true}
     Observação:

     Para testar no navegador diretamente, envolva em um conjunto de aspas duplas. Para a incorporação de aplicativos, envolva dois conjuntos de aspas duplas.

5. Publish your app. Your agent is now embedded and ready to use.

URL de exemplo

"https://<cloud_env>.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=embedded&title=Conversational Agents&welcomeTitle=Welcome to conversational agents&welcomeDescription=Talk with your agent to get started&suggestions=[""Hi, what can you do"", ""Hello, how are you""]"

Incorporar agentes de conversa em serviços de terceiros

1. Crie e publique um agente de conversa.
2. Adicione um elemento <iframe> ao seu aplicativo onde você deseja que o agente de conversa apareça.
3. Defina o atributo de origem IFrame usando o seguinte formato:

   "https://<cloud_env>.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=embedded&title=<title>&welcomeTitle=<welcome_title>&welcomeDescription=<welcome_description>&suggestions=<suggestions>"
   

Perguntas frequentes

Como você recupera o agentId?

• Navegue até Agentes > Agentes de conversa, abra seu agente e copie o agentId da URL.

Existe uma maneira de tornar o Agente de Conversa público?

• Ainda não. O acesso público requer trabalho adicional relacionado a autenticação, segurança e licenciamento.

É possível injetar algum contexto no cliente?

• O suporte para injetar entradas em agentes de conversa está em desenvolvimento.