在 AnythingLLM 中使用 APIMart

​

准备工作

1. 已安装 AnythingLLM
   从 AnythingLLM 官网 下载并安装适合您操作系统的版本，或访问 GitHub
2. 已获取 APIMart API 密钥
   登录 APIMart 控制台 获取您的 API 密钥（以 sk- 开头）

​

第一步：启动 AnythingLLM 并进入设置

​

1.1 启动应用

1. 启动 AnythingLLM 桌面应用或访问 Web 版本
2. 首次启动会显示欢迎界面
3. 点击左下角的 Open settings 按钮（设置按钮）

​

1.2 进入 LLM 配置页面

1. 在左侧菜单中找到 LLM Preference 或 LLM 偏好设置
2. 点击进入 LLM 配置页面

​

第二步：配置 APIMart API

​

2.1 选择 LLM 提供商

1. 找到 LLM Provider 或 LLM 提供商 下拉菜单
2. 选择 Generic OpenAI

​

2.2 配置 API 信息

​

2.3 调整模型参数（可选）

​

2.4 保存配置

1. 点击页面底部的 Save 或 保存 按钮
2. 系统会自动测试连接
3. 如果配置正确，会显示成功提示

​

第三步：配置嵌入模型（可选）

​

3.1 进入嵌入模型设置

1. 在左侧菜单中找到 Embedding Preference 或 嵌入偏好设置
2. 点击进入嵌入模型配置页面

​

3.2 配置嵌入模型

​

第四步：创建工作空间和上传文档

​

4.1 创建工作空间

1. 返回主界面
2. 点击 + New Workspace 或 + 新建工作空间
3. 输入工作空间名称（如”技术文档助手”、“客服知识库”等）
4. 点击创建

​

4.2 上传文档

• 📄 文本文档 - .txt, .md, .pdf, .docx
• 💻 代码文件 - .py, .js, .java, .cpp 等
• 🌐 网页 - 通过 URL 抓取
• 📊 数据文件 - .csv, .json, .xml

1. 在工作空间页面，点击 Upload Documents 或 上传文档
2. 选择文件或拖拽文件到上传区域
3. 等待文档处理完成
4. 文档会自动进行向量化处理

​

4.3 管理文档

1. 查看已上传的所有文档
2. 可以删除不需要的文档
3. 可以查看文档的分块情况
4. 可以编辑文档的元数据

​

第五步：开始对话

​

5.1 基础对话

1. 在工作空间中，找到对话输入框
2. 输入您的问题或需求
3. AI 会基于您上传的文档和 APIMart 的模型生成回复

​

5.2 使用知识库功能

1. 分析您的问题
2. 在上传的文档中检索相关内容
3. 结合检索到的内容和 AI 模型生成准确回答

​

5.3 切换工作空间

1. 点击左上角的工作空间名称
2. 选择其他工作空间或创建新的
3. 每个工作空间有独立的文档和对话历史

​

高级功能

​

1. Agent 模式

• 🔍 搜索网络 - 实时获取最新信息
• 🧮 执行计算 - 处理数学和数据分析
• 📊 生成图表 - 可视化数据
• 🔗 调用 API - 与外部服务交互

1. 在工作空间设置中找到 Agent Configuration
2. 选择启用的工具和功能
3. 保存配置

​

2. 对话历史管理

• 导出对话 - 将对话导出为文本或 JSON 格式
• 搜索历史 - 快速查找历史对话
• 删除记录 - 清理不需要的对话历史

​

3. 系统提示词自定义

1. 找到 System Prompt 或 系统提示词
2. 自定义 AI 的角色和行为
3. 示例：

你是一个专业的技术支持工程师，擅长解答关于产品的技术问题。
回答时请：
1. 保持专业和礼貌
2. 提供详细的步骤说明
3. 如果不确定，建议用户联系技术支持

​

4. 多用户管理（仅限 Docker 部署）

• 创建多个用户账户
• 设置不同的权限级别
• 管理工作空间的访问权限

​

5. API 访问

• 程序化访问工作空间
• 上传和管理文档
• 发送对话请求
• 集成到您的应用中

​

常见问题

​

Q1: 无法连接到 APIMart 服务？

1. 检查 Base URL：
   • 确保是 https://api.apimart.ai/v1（包含 /v1）
   • 不要添加额外的路径或遗漏 /v1
2. 验证 API Key：
   • 确认 API Key 以 sk- 开头
   • 在 APIMart 控制台 检查密钥是否有效
3. 检查网络连接：
   • 确保能够访问 https://api.apimart.ai
   • 检查防火墙或代理设置

​

Q2: 文档上传后无法正常检索？

1. 检查嵌入模型配置：
   • 确认嵌入模型已正确配置
   • 测试嵌入模型连接
2. 重新处理文档：
   • 删除文档后重新上传
   • 检查文档格式是否支持
3. 调整检索参数：
   • 在工作空间设置中调整相似度阈值
   • 增加返回的文档块数量

​

Q3: 对话响应速度慢？

1. 切换更快的模型：
   • 使用 gpt-4o-mini 代替 gpt-4o
   • 使用 gemini-2.0-flash-exp 获得更快响应
2. 优化文档数量：
   • 减少工作空间中的文档数量
   • 删除不必要的大文件
3. 调整 Max Tokens：
   • 减少最大输出长度
   • 使用更简洁的提示词

​

Q4: 如何查看 API 使用情况和费用？

• 📊 API 调用统计
• 💰 费用明细
• 📈 使用趋势图表
• 🔍 详细的请求日志

​

Q5: AnythingLLM 支持哪些部署方式？

• 🖥️ 桌面应用 - Windows、macOS、Linux
• 🐳 Docker - 自托管部署
• ☁️ 云端版 - AnythingLLM Cloud（即将推出）

​

使用场景示例

​

1. 企业知识库

• 模型：gpt-4o-mini（高性价比）
• 文档：公司内部文档、手册、FAQ
• 功能：员工快速查询公司信息

• 新员工入职培训
• 快速查找公司政策
• 技术文档检索

​

2. 技术文档助手

• 模型：claude-sonnet-4-5-20250929（擅长代码）
• 文档：API 文档、技术规范、代码库
• 功能：辅助开发人员查找技术信息

• API 使用说明查询
• 代码示例检索
• 技术问题解答

​

3. 客户服务知识库

• 模型：gpt-4o（高质量对话）
• 文档：产品手册、FAQ、解决方案
• 功能：快速响应客户问题

• 常见问题自动回答
• 产品使用指导
• 故障排查建议

​

4. 研究和学习助手

• 模型：gpt-5（强大的理解能力）
• 文档：研究论文、教材、笔记
• 功能：辅助学习和研究

• 论文总结和分析
• 知识点解释
• 学习路径规划

​

功能特性

• 📚 私有知识库 - 在本地构建安全的私有知识库
• 🔒 数据隐私 - 所有数据存储在本地，保护隐私
• 🤖 多模型支持 - 灵活切换不同的 AI 模型
• 📄 多格式支持 - 支持各种文档格式
• 🎯 精准检索 - 基于向量的智能文档检索
• 💬 上下文对话 - 保持长对话的上下文
• 🔧 高度可定制 - 自定义提示词、参数等
• 🌐 跨平台 - 支持 Windows、macOS、Linux

​

数据安全和隐私

​

本地数据存储

• 📁 本地文件系统 - 文档存储在本地
• 🗄️ 本地向量数据库 - 向量索引存储在本地
• 💾 对话历史 - 对话记录存储在本地

​

API 调用安全

• 🔐 加密传输 - 所有 API 调用使用 HTTPS 加密
• 🔑 密钥保护 - API Key 安全存储
• 🚫 无数据留存 - APIMart 不存储您的对话内容

​

最佳实践

​

1. 文档管理

• 定期更新 - 保持文档内容最新
• 结构化组织 - 使用清晰的文件夹结构
• 命名规范 - 使用有意义的文件名
• 删除过期 - 定期清理过期文档

​

2. 提示词优化

你是助手

你是一个专业的技术支持助手，专门帮助用户解决产品相关的技术问题。

回答时请遵循以下原则：
1. 基于提供的文档内容回答，如果文档中没有相关信息，请明确告知
2. 提供详细的步骤说明，必要时给出示例
3. 使用清晰、易懂的语言
4. 对于复杂问题，建议用户联系技术支持团队

​

3. 性能优化

• 控制文档大小 - 避免上传过大的单个文件
• 合理分块 - 使用默认的文档分块设置
• 选择合适模型 - 根据任务复杂度选择模型
• 监控使用量 - 定期检查 API 使用情况

​

4. 工作空间规划

• 按项目划分 - 为不同项目创建独立工作空间
• 权限管理 - 合理设置工作空间权限（Docker 版）
• 备份数据 - 定期备份重要工作空间

​

支持与帮助

• 📚 APIMart 文档中心
• 📚 AnythingLLM 官方文档
• 📚 AnythingLLM GitHub
• 💬 Discord 社区
• 🐦 Twitter @APIMart_
• 📧 技术支持：zhihong@apimart.ai