iFrame 和 Apps 嵌入

概述

使用 iFrame 将您的对话智能体嵌入到网页应用程序中。使用此方法，您可以将对话智能体添加到第三方应用程序中，也可以使用 iFrame 组件添加到 UiPath Apps。

目标用户：希望将对话智能体嵌入自定义网页应用程序或 UiPath Apps 中的开发者和管理员。

功能可用性

功能	可用
发起新聊天	✅
聊天记录	✅
删除聊天会话	✅
设置	✅
启动提示词	✅
文件上传	✅
引文	❌
HTML 预览	✅
复制响应	✅
反馈（点赞）	✅
Debug 转储	❌

先决条件

要嵌入对话智能体，请完成以下设置步骤：

管理员或开发者设置

1. 将对话智能体发布到所需的 Orchestrator 文件夹。
2. 从实例管理中检索代理版本 ID。
3. 对于 UiPath Apps，请在 UiPath Studio 中创建一个 Apps 项目。
4. 对于第三方应用程序，请确保网页应用程序支持 iFrame 嵌入。

查找代理 ID

1. 在“实例管理”中，导航至“智能体”>“已部署的智能体” 。
2. 选择所需代理的“聊天” 。
3. 复制 URL 中的代理 ID。例如，在 URL https://cloud.uipath.com/conversationalagents/agents_/deployed/chat/342061中，代理 ID 为342061 。

用户要求：

• 经过身份验证的用户必须拥有有权访问智能体的 UiPath 帐户。
• 匿名用户必须有权访问嵌入了智能体的应用程序或界面。

嵌入智能体

URL 构建

将 iFrame 源设置为采用以下格式的 URL：

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

备注：

组织名称和租户名称区分大小写。

URL 参数

参数	必填	描述
agentId	是	已发布智能体的版本 ID
mode	否	embedded 右侧栏体验， fullscreen为全屏（默认值： fullscreen ）
title	否	聊天标头中显示的标题（默认：代理名称）
welcomeTitle	否	首次运行欢迎屏幕的标题
welcomeDescription	否	首次运行欢迎屏幕的说明
suggestions	否	首次运行的建议提示词数组
showHistory	否	显示/隐藏聊天历史记录面板（默认值： true ）

示例 URL

基本嵌入模式：

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

包含欢迎消息和建议:

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?"]

在 UiPath Apps 中嵌入

（可选）要将对话智能体嵌入到 UiPath Apps，请使用 iFrame 组件。

1. 在 UiPath Apps Studio 中打开应用程序。

2. 将iFrame组件添加到您的页面。

3. 将“iFrame来源”属性设置为构造的 URL。

4. 发布应用程序。

   

在 UiPath Apps 中嵌入对话智能体时，请使用双引号对建议数组进行转义，如以下示例所示：

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

这是必需的，因为 UiPath Apps 会将值验证为字符串。

嵌入第三方应用程序

您可以在任何支持 iFrame 嵌入的网页应用程序中嵌入对话智能体。

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>

注意事项

• 跨域策略: 确保应用程序的内容安全策略允许从uipath.com嵌入。
• 响应式设计: 配置适当的宽度和高度值，以确保在不同尺寸的屏幕上正确呈现。
• 剪贴板访问权限：包括allow="clipboard-write"以启用复制响应功能。

聊天功能

嵌入式聊天体验使用实例管理聊天用户界面，提供相同的聊天功能，但有以下例外情况和限制。

限制

在嵌入模式下，无法使用以下功能：

功能	注意
引文	引文预览不可用
Debug 转储	不可用。使用实例管理进行调试。

身份验证选项

经过身份验证的用户

对于拥有 UiPath 帐户的内部用户：

• 用户使用标准 UiPath 身份验证进行身份验证。
• 代理可以访问用户的身份信息，例如姓名和电子邮件地址。
• 我们会根据用户的许可证跟踪消耗情况。

匿名用户

对于外部或未经身份验证的场景：

• 必须在管理员门户中配置机密的外部应用程序。
• 需要由您的组织托管的令牌端点。
• 不需要个人用户许可证。
• 消耗量会从租户的单元池中扣除。

有关设置说明，请参阅匿名访问设置。

有关许可的详细信息，请参阅许可。

警告：

匿名访问允许没有 UiPath 帐户的用户与您的智能体交互。我们强烈建议将匿名代理设在您自己的门户或登录后面，以减少滥用情况。

故障排除

未加载 iFrame

• 验证 URL 构造是否正确。
• 请检查代理 ID 是否有效。
• 确保智能体已发布并正在运行。
• 检查浏览器控制台是否存在内容安全策略错误。

复制不起作用

• 确保 iFrame 包含allow="clipboard-write"属性。
• 检查浏览器的剪贴板访问权限。

后续步骤

• 匿名访问设置: 为没有 UiPath 帐户的用户启用访问
• 实例管理：完整功能参考和调试