04_RAGTool_MarkItDown_Pipeline.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. """
  4. 代码示例 04: RAGTool的MarkItDown处理管道
  5. 展示Any格式→Markdown→分块→向量化的完整流程
  6. """
  7. import os
  8. import time
  9. import tempfile
  10. from hello_agents.tools import RAGTool
  11. class MarkItDownPipelineDemo:
  12. """MarkItDown处理管道演示类"""
  13. def __init__(self):
  14. self.rag_tool = RAGTool(
  15. knowledge_base_path="./demo_rag_kb",
  16. rag_namespace="markitdown_demo"
  17. )
  18. self.temp_dir = tempfile.mkdtemp()
  19. def create_sample_documents(self):
  20. """创建多格式示例文档"""
  21. print("📄 创建多格式示例文档")
  22. print("=" * 50)
  23. # 创建Markdown文档
  24. markdown_content = """# Python编程指南
  25. ## 基础语法
  26. Python是一种解释型、高级编程语言。
  27. ### 变量和数据类型
  28. - 整数:`42`
  29. - 字符串:`"Hello World"`
  30. - 列表:`[1, 2, 3]`
  31. ### 函数定义
  32. ```python
  33. def greet(name):
  34. return f"Hello, {name}!"
  35. ```
  36. ## 面向对象编程
  37. Python支持面向对象编程范式。
  38. ### 类定义
  39. ```python
  40. class Person:
  41. def __init__(self, name):
  42. self.name = name
  43. def say_hello(self):
  44. return f"Hello, I'm {self.name}"
  45. ```
  46. """
  47. # 创建HTML文档
  48. html_content = """<!DOCTYPE html>
  49. <html>
  50. <head>
  51. <title>Web开发基础</title>
  52. </head>
  53. <body>
  54. <h1>HTML基础</h1>
  55. <p>HTML是超文本标记语言,用于创建网页结构。</p>
  56. <h2>常用标签</h2>
  57. <ul>
  58. <li>h1-h6: 标题标签</li>
  59. <li>p: 段落标签</li>
  60. <li>div: 容器标签</li>
  61. <li>span: 行内标签</li>
  62. </ul>
  63. <h2>CSS样式</h2>
  64. <p>CSS用于控制网页的样式和布局。</p>
  65. <code>
  66. body { font-family: Arial, sans-serif; }
  67. .container { max-width: 1200px; margin: 0 auto; }
  68. </code>
  69. </body>
  70. </html>"""
  71. # 创建JSON文档
  72. json_content = """{
  73. "project": "HelloAgents",
  74. "version": "1.0.0",
  75. "description": "AI Agent开发框架",
  76. "features": [
  77. "记忆系统",
  78. "RAG检索",
  79. "工具集成",
  80. "多模态支持"
  81. ],
  82. "components": {
  83. "memory": {
  84. "types": ["working", "episodic", "semantic", "perceptual"],
  85. "storage": ["SQLite", "Qdrant", "Neo4j"]
  86. },
  87. "rag": {
  88. "formats": ["PDF", "Word", "Excel", "HTML", "Markdown"],
  89. "pipeline": ["MarkItDown", "Chunking", "Embedding", "Storage"]
  90. }
  91. }
  92. }"""
  93. # 创建CSV文档
  94. csv_content = """名称,类型,重要性,描述
  95. 工作记忆,临时存储,0.7,存储当前会话的临时信息
  96. 情景记忆,事件记录,0.8,记录具体的事件和经历
  97. 语义记忆,知识存储,0.9,存储概念性知识和规则
  98. 感知记忆,多模态,0.6,处理图像音频等感知数据
  99. 向量检索,技术组件,0.8,基于语义相似度的检索
  100. 知识图谱,技术组件,0.9,实体关系的结构化表示"""
  101. # 保存文档到临时目录
  102. documents = {
  103. "python_guide.md": markdown_content,
  104. "web_basics.html": html_content,
  105. "project_info.json": json_content,
  106. "memory_types.csv": csv_content
  107. }
  108. file_paths = {}
  109. for filename, content in documents.items():
  110. file_path = os.path.join(self.temp_dir, filename)
  111. with open(file_path, 'w', encoding='utf-8') as f:
  112. f.write(content)
  113. file_paths[filename] = file_path
  114. print(f"✅ 创建文档: {filename}")
  115. return file_paths
  116. def demonstrate_markitdown_conversion(self, file_paths):
  117. """演示MarkItDown转换过程"""
  118. print("\n🔄 MarkItDown转换过程演示")
  119. print("-" * 50)
  120. print("MarkItDown处理流程:")
  121. print("1. 📄 检测文档格式")
  122. print("2. 🔄 转换为Markdown")
  123. print("3. 📝 保持结构信息")
  124. print("4. ✨ 统一格式输出")
  125. conversion_results = {}
  126. for filename, file_path in file_paths.items():
  127. print(f"\n处理文档: {filename}")
  128. print(f"原始格式: {os.path.splitext(filename)[1]}")
  129. start_time = time.time()
  130. # 使用RAGTool添加文档,内部会调用MarkItDown
  131. result = self.rag_tool.execute("add_document",
  132. file_path=file_path)
  133. process_time = time.time() - start_time
  134. print(f"处理结果: {result}")
  135. print(f"处理时间: {process_time:.3f}秒")
  136. print(f"✅ {filename} → Markdown → 分块 → 向量化")
  137. conversion_results[filename] = {
  138. "result": result,
  139. "time": process_time
  140. }
  141. return conversion_results
  142. def demonstrate_markdown_chunking(self):
  143. """演示基于Markdown的智能分块"""
  144. print("\n📊 基于Markdown的智能分块演示")
  145. print("-" * 50)
  146. print("Markdown分块策略:")
  147. print("• 🏷️ 标题层次感知 - 利用#、##、###结构")
  148. print("• 📝 段落语义保持 - 保持内容完整性")
  149. print("• 🔢 Token精确控制 - 适配嵌入模型")
  150. print("• 🔗 智能重叠策略 - 避免信息丢失")
  151. # 添加一个复杂的Markdown文档来演示分块
  152. complex_markdown = """# 人工智能技术栈
  153. ## 机器学习基础
  154. ### 监督学习
  155. 监督学习使用标注数据训练模型,包括分类和回归任务。
  156. #### 分类算法
  157. - 逻辑回归:用于二分类和多分类问题
  158. - 决策树:基于特征分割的树形结构
  159. - 随机森林:多个决策树的集成方法
  160. - 支持向量机:寻找最优分离超平面
  161. #### 回归算法
  162. - 线性回归:建立特征与目标的线性关系
  163. - 多项式回归:处理非线性关系
  164. - 岭回归:添加L2正则化的线性回归
  165. ### 无监督学习
  166. 无监督学习从无标注数据中发现模式和结构。
  167. #### 聚类算法
  168. - K-means:基于距离的聚类方法
  169. - 层次聚类:构建聚类树状结构
  170. - DBSCAN:基于密度的聚类算法
  171. #### 降维算法
  172. - PCA:主成分分析,线性降维
  173. - t-SNE:非线性降维,适合可视化
  174. - UMAP:保持局部和全局结构的降维
  175. ## 深度学习
  176. ### 神经网络基础
  177. 神经网络是深度学习的基础,模拟人脑神经元结构。
  178. #### 基本组件
  179. - 神经元:基本计算单元
  180. - 激活函数:引入非线性
  181. - 损失函数:衡量预测误差
  182. - 优化器:更新网络参数
  183. ### 常见架构
  184. - CNN:卷积神经网络,适合图像处理
  185. - RNN:循环神经网络,处理序列数据
  186. - LSTM:长短期记忆网络,解决梯度消失
  187. - Transformer:注意力机制,处理长序列
  188. ## 自然语言处理
  189. ### 文本预处理
  190. - 分词:将文本分割为词汇单元
  191. - 词性标注:识别词汇的语法角色
  192. - 命名实体识别:提取人名、地名等实体
  193. - 情感分析:判断文本的情感倾向
  194. ### 语言模型
  195. - N-gram:基于统计的语言模型
  196. - Word2Vec:词向量表示学习
  197. - BERT:双向编码器表示
  198. - GPT:生成式预训练模型
  199. """
  200. print(f"\n📝 添加复杂Markdown文档进行分块测试...")
  201. result = self.rag_tool.execute("add_text",
  202. text=complex_markdown,
  203. document_id="ai_tech_stack",
  204. chunk_size=800,
  205. chunk_overlap=100)
  206. print(f"分块结果: {result}")
  207. # 测试基于结构的检索
  208. print(f"\n🔍 测试基于Markdown结构的检索:")
  209. search_queries = [
  210. ("监督学习算法", "测试二级标题内容检索"),
  211. ("神经网络基础", "测试跨层级内容检索"),
  212. ("BERT GPT", "测试具体技术检索"),
  213. ("聚类降维", "测试相关概念检索")
  214. ]
  215. for query, description in search_queries:
  216. print(f"\n查询: '{query}' ({description})")
  217. search_result = self.rag_tool.execute("search",
  218. query=query,
  219. limit=2)
  220. print(f"检索结果: {search_result[:200]}...")
  221. def demonstrate_embedding_optimization(self):
  222. """演示面向嵌入的Markdown预处理"""
  223. print("\n🎯 面向嵌入的Markdown预处理演示")
  224. print("-" * 50)
  225. print("Markdown预处理优化:")
  226. print("• 🏷️ 移除格式标记,保留语义内容")
  227. print("• 🔗 处理链接格式,保留链接文本")
  228. print("• 💻 清理代码块,保留代码内容")
  229. print("• 🧹 清理多余空白,优化向量表示")
  230. # 演示预处理前后的对比
  231. raw_markdown = """## 代码示例
  232. 这是一个**重要的**Python函数:
  233. ```python
  234. def process_data(data):
  235. \"\"\"处理数据的函数\"\"\"
  236. return [item.strip() for item in data if item]
  237. ```
  238. 更多信息请参考[官方文档](https://docs.python.org)。
  239. *注意*:这个函数会`自动过滤`空值。
  240. """
  241. print(f"\n📝 原始Markdown内容:")
  242. print(raw_markdown)
  243. # 添加到RAG系统,内部会进行预处理
  244. result = self.rag_tool.execute("add_text",
  245. text=raw_markdown,
  246. document_id="preprocessing_demo")
  247. print(f"\n✅ 预处理并添加完成: {result}")
  248. # 测试预处理后的检索效果
  249. print(f"\n🔍 测试预处理后的检索效果:")
  250. search_result = self.rag_tool.execute("search",
  251. query="Python函数处理数据",
  252. limit=1)
  253. print(f"检索结果: {search_result}")
  254. def demonstrate_pipeline_performance(self):
  255. """演示处理管道性能"""
  256. print("\n⚡ 处理管道性能演示")
  257. print("-" * 50)
  258. print("性能测试指标:")
  259. print("• 📄 文档转换速度")
  260. print("• 📊 分块处理效率")
  261. print("• 🎯 向量化时间")
  262. print("• 💾 存储操作耗时")
  263. # 批量处理性能测试
  264. batch_texts = [
  265. f"批量处理测试文档 {i+1}:这是一个用于测试MarkItDown处理管道性能的示例文档。"
  266. f"文档包含了多种格式的内容,包括标题、段落、列表等结构化信息。"
  267. f"通过批量处理可以评估系统的整体性能表现。"
  268. for i in range(10)
  269. ]
  270. print(f"\n⏱️ 批量处理性能测试 (10个文档):")
  271. start_time = time.time()
  272. batch_result = self.rag_tool.batch_add_texts(
  273. batch_texts,
  274. document_ids=[f"perf_test_{i+1}" for i in range(10)]
  275. )
  276. batch_time = time.time() - start_time
  277. print(f"批量处理结果: {batch_result}")
  278. print(f"总耗时: {batch_time:.3f}秒")
  279. print(f"平均每文档: {batch_time/10:.3f}秒")
  280. # 获取最终统计
  281. stats = self.rag_tool.execute("stats")
  282. print(f"\n📊 最终统计: {stats}")
  283. def main():
  284. """主函数"""
  285. print("🔄 RAGTool的MarkItDown处理管道演示")
  286. print("展示Any格式→Markdown→分块→向量化的完整流程")
  287. print("=" * 70)
  288. try:
  289. demo = MarkItDownPipelineDemo()
  290. # 1. 创建多格式示例文档
  291. file_paths = demo.create_sample_documents()
  292. # 2. 演示MarkItDown转换过程
  293. conversion_results = demo.demonstrate_markitdown_conversion(file_paths)
  294. # 3. 演示基于Markdown的智能分块
  295. demo.demonstrate_markdown_chunking()
  296. # 4. 演示面向嵌入的预处理优化
  297. demo.demonstrate_embedding_optimization()
  298. # 5. 演示处理管道性能
  299. demo.demonstrate_pipeline_performance()
  300. print("\n" + "=" * 70)
  301. print("🎉 MarkItDown处理管道演示完成!")
  302. print("=" * 70)
  303. print("\n✨ 处理管道核心特性:")
  304. print("1. 🔄 格式统一 - Any格式→Markdown标准化")
  305. print("2. 🏗️ 结构保持 - 保留文档逻辑结构")
  306. print("3. 📊 智能分块 - 基于Markdown结构的语义分割")
  307. print("4. 🎯 嵌入优化 - 针对向量化的预处理")
  308. print("5. ⚡ 高效处理 - 批量处理和性能优化")
  309. print("\n🎯 技术优势:")
  310. print("• 统一处理 - 一套流程处理所有格式")
  311. print("• 结构感知 - 充分利用Markdown结构信息")
  312. print("• 语义保持 - 在格式转换中保持语义完整性")
  313. print("• 检索优化 - 为向量检索优化的文本表示")
  314. # 清理临时文件
  315. import shutil
  316. shutil.rmtree(demo.temp_dir)
  317. print(f"\n🧹 清理临时文件: {demo.temp_dir}")
  318. except Exception as e:
  319. print(f"\n❌ 演示过程中发生错误: {e}")
  320. import traceback
  321. traceback.print_exc()
  322. if __name__ == "__main__":
  323. main()