mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
c8259a2ff6
* docs: document network-level blocks for the assistant * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
156 lines
7.2 KiB
Plaintext
156 lines
7.2 KiB
Plaintext
---
|
||
title: "使用 AI 助手"
|
||
description: "通过键盘快捷键、选中文本、代码块、文件附件或 URL 参数打开并调用 AI 助手,在本地预览环境中测试助手响应、指令与自定义配置的行为。"
|
||
keywords: ["assistant", "键盘快捷键", "文件附件", "本地预览", "URL 参数"]
|
||
---
|
||
|
||
用户有多种方式与 AI 助手开始对话。每种方式都会在文档右侧打开一个聊天面板。用户可以提出任何问题,AI 助手会在你的文档中搜索答案。如果 AI 助手无法检索到相关信息,它会回复无法回答该问题。
|
||
|
||
<div id="use-the-assistant-in-local-preview">
|
||
## 在本地预览中使用 AI 助手
|
||
</div>
|
||
|
||
当你使用 CLI 登录后,AI 助手会在本地预览中可用。这让你可以在本地开发文档时测试 AI 助手的行为、`Assistant.md` 中的自定义指令和响应。
|
||
|
||
1. 如果还没有安装,请使用 `npm i -g mint` 安装 CLI。
|
||
2. 运行 `mint login` 进行身份验证。
|
||
3. 运行 `mint dev` 启动本地预览。
|
||
|
||
本地预览中的 AI 助手使用与你部署的文档站点相同的索引内容。
|
||
|
||
<div id="ui-placement">
|
||
## 界面位置
|
||
</div>
|
||
|
||
AI 助手出现在两个位置:搜索栏旁边的按钮和页面底部的横栏。
|
||
|
||
<Columns cols={2}>
|
||
<Frame caption="搜索栏旁的 AI 助手按钮。">
|
||
<img
|
||
src="/images/assistant/assistant-button-light.png"
|
||
className="block dark:hidden"
|
||
style={{
|
||
width: '268px',
|
||
height: 'auto',
|
||
}}
|
||
alt="浅色模式下的搜索栏和 AI 助手按钮。"
|
||
/>
|
||
<img
|
||
src="/images/assistant/assistant-button-dark.png"
|
||
className="hidden dark:block"
|
||
style={{
|
||
width: '268px',
|
||
height: 'auto',
|
||
}}
|
||
alt="深色模式下的搜索栏和 AI 助手按钮。"
|
||
/>
|
||
</Frame>
|
||
<Frame caption="页面底部的 AI 助手按钮。">
|
||
<img
|
||
src="/images/assistant/assistant-bar-light.png"
|
||
className="block dark:hidden"
|
||
style={{
|
||
width: '268px',
|
||
height: 'auto',
|
||
}}
|
||
alt="浅色模式下的 AI 助手横栏。"
|
||
/>
|
||
<img
|
||
src="/images/assistant/assistant-bar-dark.png"
|
||
className="hidden dark:block"
|
||
style={{
|
||
width: '268px',
|
||
height: 'auto',
|
||
}}
|
||
alt="深色模式下的 AI 助手横栏。"
|
||
/>
|
||
</Frame>
|
||
</Columns>
|
||
|
||
<div id="keyboard-shortcut">
|
||
## 键盘快捷键
|
||
</div>
|
||
|
||
使用键盘快捷键打开 AI 助手聊天面板:macOS 上使用 <kbd>Command</kbd> + <kbd>I</kbd>,Windows 上使用 <kbd>Ctrl</kbd> + <kbd>I</kbd>。
|
||
|
||
<div id="url-parameters">
|
||
## URL 参数
|
||
</div>
|
||
|
||
通过在 URL 上添加 `?assistant` 查询参数,从文档站点的任意页面打开 AI 助手。可用于从外部内容(如邮件、支持回复、应用内横幅或新手引导流程)深度链接到 AI 助手。
|
||
|
||
- `?assistant`:打开 AI 助手聊天面板,但不发送任何消息。
|
||
- `?assistant=<消息>`:打开 AI 助手聊天面板,并将 `<消息>` 作为用户的第一条消息发送。请对参数值进行 URL 编码,以确保空格和特殊字符在请求中被正确保留。
|
||
|
||
```text 示例
|
||
https://yourdocs.mintlify.site/quickstart?assistant
|
||
https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started%3F
|
||
```
|
||
|
||
<div id="highlight-text">
|
||
## 选中文本
|
||
</div>
|
||
|
||
在页面上选中文本,然后点击弹出的 **Add to assistant** 按钮,即可打开 AI 助手聊天面板并将选中的文本添加为上下文。你可以向 AI 助手的上下文中添加多个文本片段或代码块。
|
||
|
||
<Frame>
|
||
<img src="/images/assistant/highlight-light.png" alt="浅色模式下选中文本上方的 Add to assistant 按钮。" className="block dark:hidden" />
|
||
<img src="/images/assistant/highlight-dark.png" alt="深色模式下选中文本上方的 Add to assistant 按钮。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<div id="code-blocks">
|
||
## 代码块
|
||
</div>
|
||
|
||
点击代码块中的 **询问助手** 按钮,打开 AI 助手聊天面板并将代码块添加为上下文。你可以向 AI 助手的上下文中添加多个代码块或文本片段。
|
||
|
||
<Frame>
|
||
<img src="/images/assistant/code-block-light.png" alt="浅色模式下代码块中的“询问助手”按钮。" className="block dark:hidden" />
|
||
<img src="/images/assistant/code-block-dark.png" alt="深色模式下代码块中的“询问助手”按钮。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<div id="file-attachments">
|
||
## 文件附件
|
||
</div>
|
||
|
||
向 AI 助手消息附加文件以提供额外的上下文。
|
||
|
||
支持的文件类型:
|
||
- **图片**:JPEG、PNG、GIF、WebP、SVG
|
||
- **文档**:PDF
|
||
- **代码和文本文件**:JavaScript (`.js`、`.jsx`、`.mjs`、`.cjs`)、TypeScript (`.ts`、`.tsx`)、Python、HTML、CSS、Markdown、MDX、JSON、YAML、XML、SQL、CSV、纯文本、Shell 脚本 (`.sh`、`.bash`、`.env`)、GraphQL、TOML、Go、Rust、Ruby、Java、Kotlin、Swift、C (`.c`、`.h`)、C++ (`.cpp`、`.hpp`)、C#、PHP、Lua、R、Scala
|
||
|
||
限制:
|
||
- 最大文件大小:每个附件 5 MB
|
||
- 每条消息最大附件数:10
|
||
|
||
<Frame>
|
||
<img src="/images/assistant/image-attach-light.png" alt="在 AI 助手聊天面板中添加的图片作为上下文。" className="block dark:hidden" />
|
||
<img src="/images/assistant/image-attach-dark.png" alt="在 AI 助手聊天面板中添加的图片作为上下文。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<div id="troubleshooting">
|
||
## 故障排除
|
||
</div>
|
||
|
||
<Accordion title="AI 助手聊天栏不可见">
|
||
如果 AI 助手界面在某些浏览器中不可见,你可能需要向 [EasyList](https://easylist.to) 提交误报报告。使用 EasyList Cookies List 的浏览器(如 Brave 和 Comet)有时会屏蔽 AI 助手或其他界面元素。EasyList Cookies List 包含特定域名的规则,用于隐藏某些域名上的固定元素以屏蔽 Cookie 横幅。此规则会无意中影响合法的界面组件。
|
||
|
||
向 [EasyList](https://github.com/easylist/easylist) 提交误报报告以请求移除该规则。一旦过滤列表更新,这将为所有用户解决此问题。
|
||
|
||
</Accordion>
|
||
|
||
<Accordion title="AI 助手在公司网络、VPN 或防火墙下被阻止">
|
||
如果 AI 助手在个人网络上可以加载,但在工作网络、VPN 或其他受限网络下无法加载,则该阻止发生在网络层面,而不是文档站点本身。企业代理、VPN 和防火墙有时会阻止 AI 助手需要发起的出站请求,因此即使站点的其他部分能够正常加载,聊天面板也无法连接。
|
||
|
||
**对读者:** 请你的 IT 团队允许从你的网络向以下主机发起出站 HTTPS 请求。如果可以,请尝试从个人网络使用 AI 助手,以确认问题是网络特定的。
|
||
|
||
- `leaves.mintlify.com` — AI 助手 API
|
||
- `*.mintlify.dev` — AI 助手流式传输和相关服务
|
||
- `*.mintlify.com` — 仪表盘、API 和分析
|
||
- `hcaptcha.com` 和 `*.hcaptcha.com` — AI 助手的 CAPTCHA 验证
|
||
|
||
**对站点所有者:** 如果读者报告 AI 助手在其公司网络或 VPN 下无法加载,几乎总是出站网络阻止的问题,而不是你的文档存在问题。请将上述主机告知他们,并建议他们把该列表分享给其 IT 团队。这是应用于访问者设备或网络的网络层允许列表,无法通过你的站点进行配置。如果你在覆盖默认 CSP 的反向代理后自托管,请参阅 [CSP 配置](/zh/deploy/csp-configuration),了解需要允许的域名。
|
||
|
||
</Accordion>
|