文档
了解如何使用 Asyntai
GitHub 集成
根据你的文档在 Issues 和 Discussions 中回答问题
概述
Asyntai GitHub 应用会回答人们在你的仓库中提出的问题。当有人在 Q&A 分类中发起 Discussion,或创建带有你的问题标签的 Issue 时,Asyntai 会阅读你的文档并以评论形式发布答案。你的维护者可以把时间留给错误报告和代码。
它面向把文档放在 Asyntai 中的项目:文档站点、README、帮助中心或上传的文件。答案来自这些内容,也就是你网站聊天所用的同一个知识库。
工作原理
应用在三个地方回答:
- Discussions:接受回答的分类(例如 Q&A)中的每个新讨论。
- Issues:带有你所选标签的每个新 issue。默认标签是
question。错误报告和功能请求仍由你的团队处理。 - 追问:任何人都可以在评论中提及
@asyntai-ai-agent继续提问。应用会记住该话题,因此追问会在上下文中被理解。
每个答案都以你的文档为依据。文档未涵盖的问题会留给维护者,因此应用写下的每条评论都值得信赖。
要求
- 一个知识库中已有你文档的 Asyntai 账户。免费方案足以开始。
- 一个你可以安装应用的 GitHub 仓库,位于个人账户或组织中。
- 对于 Discussions,需要一个接受回答的分类。GitHub 称之为 Q&A 分类。
安装
按以下步骤将 Asyntai 添加到你的仓库:
在 GitHub 上安装应用
在 GitHub Marketplace 中打开 Asyntai 应用并点击 Install。选择允许它回答的账户和仓库。之后可以在 GitHub 设置中更改仓库。
https://github.com/apps/asyntai-ai-agent
连接您的 Asyntai 账户
安装完成后,GitHub 会把你带到 Asyntai。登录或创建免费账户,然后选择应用用来回答的知识库所属网站。此操作只需一次。
选择在哪里回答
在 Asyntai 仪表板的 GitHub 页面上,开启或关闭 Discussions 和 Issues,并设置将 issue 标记为问题的标签。设置适用于该安装中的每个仓库。
提问
在你的 Q&A 分类中发起讨论,或创建带问题标签的 issue。答案会在一分钟内以评论形式出现。在回复中提及应用即可追问。
提示: 在你的Asyntai 仪表板中把文档站点、README 和 changelog 添加到知识库。应用拥有的文档越多,能回答的问题就越多。
应用能做什么
- 根据你的文档全天候回答安装、配置和使用问题
- 以 GitHub Markdown 撰写,命令和配置使用代码块
- 链接到答案所依据的文档页面
- 为追问保留每个话题的上下文
- 用提问所用的语言回答
- 把错误报告、功能请求和 pull request 留给你的团队
权限
应用请求 Issues 和 Discussions 的读写权限,以便读取问题并发布答案,以及仓库元数据的读取权限。
隐私
Asyntai 接收问题文本、仓库名称和提问者的 GitHub 用户名。每个已回答的话题都会作为对话保存在你的 Asyntai 仪表板中,就像网站上的一次聊天。
套餐与价格
GitHub 集成在包括免费方案在内的所有 Asyntai 方案中都可用。每个答案计为你每月额度中的一条消息,该额度由你的所有渠道和集成共享。 查看定价.
卸载
打开 GitHub 设置,依次进入 Applications、Installed GitHub Apps,然后卸载 Asyntai。应用会立即停止回答。你也可以在 Asyntai 仪表板的 GitHub 页面上点击断开连接。
需要帮助?
如果您有任何问题或遇到困难,请通过 [email protected] 联系我们。