Skip to content

Commit cb49c79

Browse files
committed
docs: add function call tutorial
1 parent d04b181 commit cb49c79

10 files changed

Lines changed: 356 additions & 108 deletions

README.md

Lines changed: 33 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,9 @@ VoidMuse致力于通过**开源组件整合**的方式,以**最低的开发成
4242

4343
## 🚀 快速开始
4444

45-
### 🎯 三分钟快速上手
46-
47-
想要立即体验VoidMuse的强大功能?跟着我们的快速配置指南,三步搞定!
48-
49-
👉 **[📖 查看三步快速上手指南](doc/quick-start.md)**
50-
51-
> 💡 只需配置AI模型API密钥,就能开始使用基础功能。搜索和代码理解功能可以后续按需配置。
5245

53-
### 两种使用方式
54-
55-
#### 🎯 作为用户 - 直接使用插件
46+
### 使用方式
47+
直接使用插件
5648

5749
**VS Code安装**
5850
1. 打开VS Code扩展商店 (Ctrl+Shift+X)
@@ -64,32 +56,16 @@ VoidMuse致力于通过**开源组件整合**的方式,以**最低的开发成
6456
2. 搜索 "VoidMuse"
6557
3. 点击安装并重启IDE
6658

67-
#### 🔧 作为学习者 - 本地开发学习
68-
69-
```bash
70-
# 克隆学习型项目
71-
git clone https://github.com/your-org/voidmuse.git
72-
cd voidmuse
59+
作为学习者 - 本地开发学习【另外一个系列讲】
7360

74-
# 安装前端依赖
75-
cd gui
76-
npm install
7761

78-
# 启动开发服务器
79-
npm run dev
62+
### 🎯 三分钟快速上手
8063

81-
# 安装VS Code插件依赖
82-
cd ../extensions/vscode
83-
npm install
64+
想要立即体验VoidMuse的强大功能?跟着我们的快速配置指南,三步搞定!
8465

85-
# 启动VS Code插件调试
86-
npm run compile
87-
# 按F5启动调试
66+
👉 **[📖 查看三步快速上手指南](doc/quick-start.md)**
8867

89-
# 构建IntelliJ插件
90-
cd ../intellij
91-
./gradlew buildPlugin
92-
```
68+
> 💡 只需配置AI模型API密钥,就能开始使用基础功能。搜索和代码理解功能可以后续按需配置。
9369
9470
### 详细配置指南
9571

@@ -100,11 +76,6 @@ cd ../intellij
10076
- 🔍 **[博查搜索配置](doc/bochaSearchConfig.md)** - 国内搜索服务配置
10177
- 🧠 **代码理解配置** - 使用相同的AI模型API即可
10278

103-
详细配置指南请参考:
104-
- [基础配置指南](docs/basic-setup.md)
105-
- [开发环境搭建](docs/dev-environment.md)
106-
- [调试与学习技巧](docs/debug-and-learn.md)
107-
10879
---
10980

11081
## 🏗️ 整体架构
@@ -130,32 +101,20 @@ cd ../intellij
130101

131102
我们精心选择并整合了以下优秀开源组件:
132103

133-
#### 前端技术栈
134-
- **React 18.x** - 现代化UI框架
135-
- **TypeScript 5.x** - 类型安全的JavaScript超集
136-
- **Vite 4.x** - 快速的前端构建工具
137104
- **Ant Design 5.x** - 企业级UI设计语言
138105
- **TipTap** - 富文本编辑器
106+
- **Vercel的 ai-sdk** - 多模型支持、agent框架
139107

140-
#### AI相关组件
141-
- **@ai-sdk/anthropic** - Claude模型集成
142-
- **@ai-sdk/openai** - OpenAI模型支持
143-
- **@ai-sdk/deepseek** - DeepSeek模型适配
144-
- **@openrouter/ai-sdk-provider** - 多模型路由支持
145-
- **@modelcontextprotocol/sdk** - MCP协议实现
146108

147-
#### IDE集成
148-
- **VS Code Extension API** - VS Code插件开发
149-
- **IntelliJ Platform SDK** - IDEA插件框架
150-
- **Gradle** - Java项目构建工具
109+
### 📖 学习资源汇总
151110

152-
### 📖 深度学习资源
153-
154-
- [Codebase原理详解](docs/codebase-principles.md)
155-
- [提高检索准确率的10种方法](docs/accuracy-optimization.md)
156-
- [Embedding技术深度解析](docs/embedding-guide.md)
157-
- [AI工程化最佳实践](docs/ai-engineering.md)
158-
- [MCP协议技术解析](docs/mcp-protocol.md)
111+
1. 微软 AI Agents for Beginners:构建AI代理的基础知识,https://learn.microsoft.com/zh-cn/shows/ai-agents-for-beginners/
112+
2. 吴恩达 Agentic AI 课程:代理式AI的实际应用,https://deeplearning.ai
113+
3. Hugging Face AI Agents 课程:实用的AI智能体开发技能,https://huggingface.co/learn/agents-course/zh-CN/unit0/introduction
114+
4. Google 5天 AI Agent 培训课:实战项目经验,https://rsvp.withgoogle.com/events/google-ai-agents-intensive_2025/home
115+
5. Anthropic 官方课程:高级AI Agent技术,https://anthropic.skilljar.com
116+
6. Coursera AI Agents 专项课程:学术理论与实际应用结合,https://coursera.org/specializations/ai-agents
117+
7. Salesforce AI Agent Course:企业级AI Agent解决方案,https://salesforce.com/ap/agentforce/ai-agent-course/
159118

160119
---
161120

@@ -178,7 +137,7 @@ cd ../intellij
178137
- 本地化向量数据库
179138
- 语义相似度检索
180139
- 智能代码上下文提取
181-
- **深度文档**: [Codebase技术原理](docs/codebase-deep-dive.md)
140+
- **深度文档**: [Codebase技术原理](doc/codebase-deep-dive.md)
182141

183142
### 💬 多模型AI对话 (AI Chat)
184143

@@ -221,38 +180,32 @@ cd ../intellij
221180
### 📖 推荐学习路径
222181

223182
#### 初级路径 (AI概念入门)
224-
1. [什么是Embedding?](docs/embedding-basics.md)
225-
2. [向量数据库基础](docs/vector-db-intro.md)
226-
3. [大模型API使用指南](docs/llm-api-guide.md)
183+
1. [什么是Embedding?](doc/tutorial/embedding-basics.md)
184+
2. [向量数据库基础]()
227185

228186
#### 高级路径 (工程实践)
229-
1. [Codebase索引原理与实现](docs/codebase-implementation.md)
230-
2. [提高检索准确率的策略](docs/retrieval-optimization.md)
231-
3. [多模型适配架构设计](docs/multi-model-architecture.md)
232-
4. [MCP协议深度解析](docs/mcp-deep-dive.md)
187+
1. [Codebase索引原理与实现](doc/tutorial/codebase-implementation.md)
188+
2. [提高检索准确率的策略]()
189+
3. [多模型适配架构设计]()
190+
4. [MCP协议深度解析]()
233191

234192
### 🛠️ 实践项目
235193

236-
- [构建你的第一个AI插件](docs/build-your-plugin.md)
237-
- [自定义Embedding模型集成](docs/custom-embedding.md)
238-
- [扩展MCP协议支持](docs/extend-mcp.md)
239-
- [实现自定义搜索引擎](docs/custom-search.md)
194+
- [实现深度搜索](doc/tutorial/function%20call的实践-实现深度搜索.md)
195+
- [Embedding模型踩坑合集]()
196+
- [自定义Embedding模型集成]()
197+
- [扩展MCP协议支持]()
198+
- [实现自定义搜索引擎]()
240199

241200
---
242201

243202
## 🚀 未来功能规划
244203

245-
| 功能模块 | 核心特性 | 技术原理 | 计划时间 | 学习价值 |
246-
|---------|---------|---------|---------|----------|
247-
| 🧠 **上下文记忆** | 跨会话记忆、智能优先级、个性化学习 | 向量数据库 + 语义检索 | xxx | AI记忆系统设计 |
248-
| 🗜️ **上下文压缩** | 动态长度管理、多级压缩、语义保持 | 智能摘要 + 分层压缩 | xxx | 大模型上下文优化 |
249-
| 🤖 **Agent代码生成** | 需求分析、架构设计、自动实现、测试验证 | 多Agent协作框架 | xxx | AI驱动软件开发 |
250-
251-
### 🤝 参与开发
252-
253-
欢迎社区贡献:**算法优化** | **原型开发** | **测试验证** | **文档编写**
254-
255-
📖 技术文档:[记忆系统](docs/context-memory-design.md) | [压缩算法](docs/compression-algorithms.md) | [Agent架构](docs/agent-architecture.md) | [协作协议](docs/multi-agent-protocol.md)
204+
| 功能模块 | 核心特性 | 技术原理 | 学习价值 |
205+
|---------|---------|---------|----------|
206+
| 🧠 **上下文记忆** | 跨会话记忆、智能优先级、个性化学习 | 向量数据库 + 语义检索 |AI记忆系统设计 |
207+
| 🗜️ **上下文压缩** | 动态长度管理、多级压缩、语义保持 | 智能摘要 + 分层压缩 |大模型上下文优化 |
208+
| 🤖 **Agent代码生成** | 需求分析、架构设计、自动实现、测试验证 | 多Agent协作框架 | AI驱动软件开发 |
256209

257210
---
258211

@@ -283,33 +236,6 @@ cd ../intellij
283236

284237
详细贡献指南:[贡献指南](doc/contributing.md)
285238

286-
### 快速开始贡献
287-
288-
1. **Fork项目** 到你的GitHub账户
289-
2. **创建特性分支** (`git checkout -b feature/AmazingFeature`)
290-
3. **提交更改** (`git commit -m 'Add some AmazingFeature'`)
291-
4. **推送到分支** (`git push origin feature/AmazingFeature`)
292-
5. **开启Pull Request**
293-
294-
---
295-
296-
## 🙏 致谢
297-
298-
### 开源组件致谢
299-
300-
感谢以下优秀的开源项目:
301-
302-
- [React](https://reactjs.org/) - 用户界面构建库
303-
- [Ant Design](https://ant.design/) - 企业级UI设计语言
304-
- [Vite](https://vitejs.dev/) - 下一代前端构建工具
305-
- [TypeScript](https://www.typescriptlang.org/) - JavaScript的超集
306-
- [AI SDK](https://sdk.vercel.ai/) - 统一的AI模型接口
307-
- [Model Context Protocol](https://modelcontextprotocol.io/) - AI工具调用标准
308-
- [TipTap](https://tiptap.dev/) - 无头富文本编辑器
309-
- [VS Code Extension API](https://code.visualstudio.com/api) - VS Code扩展开发
310-
- [IntelliJ Platform SDK](https://plugins.jetbrains.com/docs/intellij/) - IntelliJ插件开发
311-
312-
313239
### 社区贡献者
314240

315241
感谢所有为项目贡献代码、文档和想法的开发者们。你们的贡献让VoidMuse变得更好!
24.2 KB
Loading
228 KB
Loading
127 KB
Loading
128 KB
Loading
77.3 KB
Loading
57.8 KB
Loading

doc/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ A: 第一次使用需要建立索引,大项目可能需要几分钟时间
205205
### 🔗 获取帮助
206206

207207
- 📖 [查看详细文档](../README.md)
208-
- 🐛 [提交问题](https://github.com/your-org/voidmuse/issues)
208+
- 🐛 [提交问题](https://github.com/voidmuse-dev/voidmuse/issues)
209209
- 💬 [加入交流群](../README.md#-联系我们)
210210

211211
---

doc/tutorial/embedding-basics.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# 什么是Embedding?深入浅出理解向量表示
2+
3+
## 引言:给内容一个"数字身份证"
4+
5+
想象一下,如果要给每个人发一张身份证,这张身份证不仅包含姓名,还能体现这个人的性格、爱好、技能等各种特征。Embedding就是给文字、图片、音频等内容发放的"数字身份证"——它将人类理解的复杂信息转换成计算机能够理解和计算的向量形式。
6+
7+
## 核心概念:把内容用向量表现出来
8+
9+
### 什么是向量表示?
10+
11+
Embedding本质上是一种**向量表示技术**,它将复杂的语义信息压缩成一串数字。比如:
12+
13+
- 单词"苹果"可能被表示为:`[0.2, -0.1, 0.8, 0.3, ...]`
14+
- 句子"今天天气很好"可能被表示为:`[0.5, 0.7, -0.2, 0.9, ...]`
15+
16+
这些数字看似随机,实际上每个维度都捕捉了内容的某种特征。
17+
18+
### 相似性的魔法
19+
20+
Embedding最神奇的地方在于:**语义相似的内容在向量空间中距离更近**
21+
22+
例如:
23+
- "猫"和"狗"的向量距离比"猫"和"汽车"更近
24+
- "开心"和"快乐"的向量几乎重叠
25+
- "苹果公司"和"iPhone"的向量距离比"苹果水果"和"iPhone"更近
26+
27+
## 实际应用例子
28+
29+
### 1. 智能搜索引擎
30+
当你搜索"苹果"时,搜索引擎通过embedding能够:
31+
- 理解你是想找水果还是科技公司
32+
- 根据上下文和搜索历史给出精准结果
33+
34+
### 2. 推荐系统
35+
Netflix的电影推荐:
36+
- 将每部电影转换为embedding向量
37+
- 找到与你喜欢的电影向量相似的其他电影
38+
- 推荐给你可能喜欢的内容
39+
40+
### 3. 机器翻译
41+
Google翻译理解"bank"的不同含义:
42+
- "river bank"(河岸)
43+
- "money bank"(银行)
44+
- 通过上下文的embedding准确翻译
45+
46+
### 4. 图像识别
47+
将图片转换为向量:
48+
- 猫的图片embedding与其他猫的图片相似
49+
- 能够识别从未见过的猫的品种
50+
51+
## Embedding的重要技术指标
52+
53+
### 1. 维度(Dimension)
54+
- **定义**:向量的长度,即包含多少个数字
55+
- **常见范围**:128维到4096维
56+
- **影响**
57+
- 维度越高,能表达越复杂、越细致的信息
58+
- 维度越高,计算成本越大
59+
- 需要在表达能力和效率间平衡
60+
61+
**示例**
62+
- 128维:适合简单的词汇embedding
63+
- 768维:BERT模型的标准维度
64+
- 1536维:OpenAI text-embedding-ada-002的维度
65+
66+
### 2. 上下文窗口(Context Window)
67+
- **定义**:模型能同时处理的文本长度
68+
- **重要性**:决定了模型理解长文本的能力
69+
- **常见范围**
70+
- 512 tokens:早期BERT模型
71+
- 2048 tokens:GPT-3
72+
- 8192+ tokens:现代大模型
73+
74+
### 3. 相似度计算方法
75+
- **余弦相似度**:最常用,关注向量方向
76+
- **欧几里得距离**:关注向量间的直线距离
77+
- **点积**:计算简单,但受向量长度影响
78+
79+
### 4. 训练数据质量
80+
- **数据规模**:训练数据越多,embedding质量越好
81+
- **数据多样性**:覆盖更多领域和语言
82+
- **数据质量**:高质量数据产生更准确的表示
83+
84+
### 5. 语言支持
85+
- **单语言**:只支持一种语言
86+
- **多语言**:支持多种语言的跨语言理解
87+
- **跨模态**:支持文本、图像、音频等多种模态
88+
89+
## 总结
90+
91+
Embedding是现代AI系统的基础技术,它让计算机能够"理解"人类的语言和内容。通过将复杂的语义信息转换为数学向量,我们能够:
92+
93+
1. **量化语义相似性**:让计算机理解内容之间的关系
94+
2. **支持智能应用**:搜索、推荐、翻译等AI应用的核心
95+
3. **跨模态理解**:连接文本、图像、音频等不同类型的内容
96+
97+
理解embedding的原理和应用,是掌握现代AI技术的重要一步。随着技术的发展,embedding将在更多场景中发挥重要作用,成为连接人类智能和机器智能的桥梁。

0 commit comments

Comments
 (0)