循序渐进 · AIP 教学 · AIP Assist(四)

注册自定义内容源

这一步是把内部文档登记进平台,让 AIP Assist 能检索到它。用它可以加速工作流、改善新人上手、自动回答支持类问题。

本文来源 · Source 内容整理自 Palantir Foundry 官方文档:
https://www.palantir.com/docs/foundry/assist/aip-assist-registering-content/
原始标题:AIP Assist • Power AIP Assist with custom content sources • Register custom content sources • Palantir · 所属:AIP Assist(平台里的 AI 助手)

先记住这几条

① 注册是前置动作
不注册,助手就看不到你的内容。
② 内容源有格式要求
要按规范组织。
③ 目的很务实
降支持成本、加速上手。
0

写在前面

利用 AIP Assist,通过让它从自定义内容源传递有针对性的指引,来加速工作流程、用户入门并自动化支持。你可以让 AIP Assist 提供来自平台内自定义文档或 Notepad 文档的现有内容,方法是注册你的内容源,使其可供 AIP Assist 使用。为此,请根据你的内容源,按以下步骤操作 Notepad 或平台内自定义文档。之后,还需要在 Control Panel 中进行额外配置,以允许 AIP Assist 在回答用户查询时提供你的内容。

在大多数情况下,我们推荐使用 Notepad,因为通过在 Workshop 等其他应用中嵌入,它在 Palantir 平台上具有广泛的用途。要了解更多信息,请查阅 Notepad 文档。如果平台内自定义文档更适合你的用例,但尚未启用,请联系你的 Palantir 代表为你的 enrollment 启用它。

我们强烈建议你在编写和更新内容时,查阅自定义内容源最佳实践

1

用 Notepad 作为内容源

要点:轻量做法,适合小规模内容。

此功能目前可能并非在所有 enrollment 上都可用。如果你没有看到将 Notepad 文档添加到 AIP Assist 的选项,请联系你的 Palantir 代表,确认你的 enrollment 是否符合条件。

以下说明详细介绍了如何将 Notepad 文档添加为 AIP Assist 自定义内容源:

  1. 通过选择 + New Document 创建 Notepad 文档,或导航至现有文档。确保你的文档属于某个项目
  1. 打开 Notepad 文档右上角的 Actions 下拉菜单,然后选择 Add to AIP Assist。这将打开一个对话框,你可以在其中授予 AIP Assist 对你的文档的访问权限。该选项可能需要一些时间才会出现,因为文档需要先被 AIP Assist 发现。
The
The "Add to AIP Assist" option in the Notepad actions dropdown menu.
  1. 在对话框中切换 Add to AIP Assist 选项,并填写 Documentation titleDescription 字段。这些字段应具有描述性,并具体针对你文档中的内容。
The
The "Add to AIP Assist toggle, Documentation title, and Description fields.
  1. 选择 Save,并确保显示成功消息,确认文档已被摄取到 AIP Assist 中。
A sample success message after ingesting a Notepad document.
A sample success message after ingesting a Notepad document.

你的内容现已摄取到 AIP Assist 中,并将在 Control Panel 中可供可见性配置。请确保你首先按用户和组为 Notepad 文档配置可见性设置,因为 AIP Assist 会遵循现有权限。

2

用平台内自定义文档作为内容源

要点:正式做法,适合体系化文档。

要使用此功能,你必须在 Code Repositories 中已有一个 documentation 仓库。如果此功能对你的 enrollment 不可用,请联系你的 Palantir 代表启用 documentation 类型仓库,或者如果该功能已启用,则在创建后将该仓库加入白名单。

Initialize a Documentation repository from the Documentation template.
Initialize a Documentation repository from the Documentation template.

要授予 AIP Assist 对你平台内自定义文档的访问权限,请向你的 documentation 仓库添加内容,并选择加入以将信息提供给 AIP Assist。

  1. 确保你已在 Code Repositories 中初始化了一个 documentation 仓库。通过在 docs 文件夹中创建新文件夹(即 "product")来填充内容。
Create a product folder.
Create a product folder.
  1. 在一个 "product" 文件夹中(下文的 "Custom\_Docs\_Support\_Alert\_Example"),创建一个包含 @name@descriptionoverview.md 文件,随后以 Markdown 格式编写你的文档。
Create your @name, @description followed by documentation in your new product folder.
Create your @name, @description followed by documentation in your new product folder.
  1. 当你完成向 documentation 仓库填充内容后,将仓库顶层现有的 _aip-assist.json 文件重命名为 aip-assist.json原始文件可能会在一段时间后重新生成;无需进行任何操作。
  1. 在该文件中,列出你想要选择加入 AIP Assist 的 "product" 文件夹及其描述。该描述将提供给 AIP Assist,以便它评估何时查询自定义文档。确保描述全面且简洁。提交你的更改,并确保文档作为检查的一部分被发布。
Opt-in to ingesting it to AIP Assist.
Opt-in to ingesting it to AIP Assist.
3

常见问题

要点:注册相关的疑问。

Will content updates in custom documentation or Notepad documents be reflected in the information AIP Assist provides to users?

平台内自定义文档或 Notepad 文档中的每一次更新都会自动传播并更新我们的数据库。无需进一步操作即可更新 AIP Assist 中的内容。

Why are images not visible in AIP Assist responses?

目前,AIP Assist 仅显示来自 Palantir 公共文档和平台内自定义文档的图片,但我们正在努力使其也支持 Notepad 图片。在此之前,我们建议在图片下方添加描述。这些文本将在 AIP Assist 中呈现,并且答案中会添加行内引用。当用户选择引用时,他们将被重定向到你的内容,在那里可以查看任何相关图片。

Why is the AIP Assist button not visible under actions in Notepad?

目前,你无法将空的 Notepad 文档添加到 AIP Assist,因此请确保你的文档包含内容。如果你刚刚添加了内容或向 Notepad 粘贴了一份大型文档,请给它一些时间来更新,因为新资源可能需要一些时间才能传播。

请确保你的 enrollment 已启用 AIP,你的 Notepad 文档位于某个项目中,并且该项目具有组织标记(Markings)

延伸阅读 · 相关页面

按主题横向跳转,不必顺着目录一篇篇读。

本组其他页面 · AIP Assist(平台里的 AI 助手)

同一主题下的相邻内容。

常见问题速答 · FAQ

关于「注册自定义内容源」,读者最常问的几个问题。

用平台内自定义文档作为内容源是什么?
正式做法,适合体系化文档。要使用此功能,你必须在 Code Repositories 中已有一个 documentation 仓库。如果此功能对你的 enrollment 不可用,请联系你的 Palantir 代表启用 documentation 类型仓库,或…
还有哪些问题?
注册相关的疑问。平台内自定义文档或 Notepad 文档中的每一次更新都会自动传播并更新我们的数据库。无需进一步操作即可更新 AIP Assist 中的内容。