Skip to main content

你将构建的内容

一个可复用的小部件,可将AI 助手直接嵌入到你的应用中。该小部件提供:
  • 浮动按钮,点击即可打开聊天面板
  • 基于你的文档信息的实时流式回复
  • 支持 Markdown 的消息渲染
用户无需离开你的应用即可通过该小部件获取产品帮助。
演示打开助手小部件,用户输入“如何开始?”,随后助手作出回应。

先决条件

  • Mintlify Pro 或 Custom 计划
  • 你的 domain 名称,它位于控制台 URL 的末尾。例如,如果你的控制台 URL 是 https://dashboard.mintlify.com/org-name/domain-name,你的 domain 名称就是 domain-name
  • 一个 AI 助手 API key
  • 已安装 Node.js v18 或更高版本及 npm
  • 基础的 React 知识

获取你的 AI 助手 API key

  1. 在控制台中前往 API keys 页面。
  2. 点击 Create Assistant API Key
  3. 复制 AI 助手 API key(以 mint_dsc_ 开头)并妥善保存。
AI 助手 API key 是一个可在前端代码中使用的公共令牌。使用该令牌的调用将计入你套餐的消息配额,并可能产生超额费用。

设置示例

最快的上手方式是克隆示例存储库,并按需进行自定义。
1

克隆存储库

2

配置你的项目

打开 src/config.js,并填入你的 Mintlify 项目信息:
src/config.js
将以下内容替换为你的实际信息:
  • your-domain 替换为你在控制台 URL 末尾看到的 Mintlify 项目 domain。
  • https://yourdocs.mintlify.app 替换为你的文档实际 URL。
3

添加你的 API 令牌

在项目根目录创建一个 .env 文件:
.env
mint_dsc_your_token_here 替换为你的 AI 助手 API key。
4

启动开发服务器

在浏览器中打开你的应用,点击 Ask 按钮以打开 AI 助手挂件。

项目结构

此示例采用组件化架构。
关键文件:
  • src/App.jsx:主应用组件。演示如何导入并使用 AssistantWidget 组件。
  • src/config.js:集中配置。在此文件中更新你的 domain 和文档 URL。
  • src/components/AssistantWidget.jsx:主要的挂件组件。管理打开/关闭状态、聊天消息和 API 调用。
  • src/utils.js:包含用于解析 AI 助手响应格式并提取来源的实用函数。
  • src/components/Message.jsx:渲染单条消息,支持 Markdown 和建议链接。

自定义思路与示例

来源引注

从 AI 助手的回复中提取并显示出处:

跟踪会话线程 ID

存储线程 ID,以在不同会话中保留对话历史:

添加键盘快捷键

允许用户通过键盘快捷键打开组件并提交消息: