QMD 搜索技能

使用 qmd 高效搜索 Markdown 知识库，qmd 是一种本地索引工具，它结合 BM25 算法和向量嵌入技术，仅返回相关片段而非整个文件。

为何使用此功能

• 96% 的令牌削减- 返回相关片段，无需读取整个文件
• 即时结果- 预索引内容意味着快速搜索
• 本地化与隐私保护- 所有索引和搜索均在本地进行
• 混合搜索- BM25 用于关键词匹配，向量搜索用于语义相似性

命令

搜索（BM25 关键词匹配）

qmd search "your query" --collection <name>

快速、准确的基于关键词的搜索。最适合特定术语或短语。

向量搜索（语义）

qmd vsearch "your query" --collection <name>

语义相似性搜索。最适合概念性查询，其中确切用词可能有所不同。

混合搜索（两者结合 + 重新排序）

qmd hybrid "your query" --collection <name>

结合两种方法，并使用 LLM 重新排序。最全面，但通常有些大材小用。

如何使用

1. 检查集合是否存在:

   qmd collection list
   

2. 搜索集合:

   # For specific terms
   qmd search "api authentication" --collection notes
   
   # For conceptual queries
   qmd vsearch "how to handle errors gracefully" --collection notes
   

3. 读取结果: qmd 返回包含文件路径和上下文的相关片段

设置（如果未安装 qmd）

# Install qmd
bun install -g https://github.com/tobi/qmd

# Add a collection (e.g., Obsidian vault)
qmd collection add ~/path/to/vault --name notes

# Generate embeddings for vector search
qmd embed --collection notes

调用示例

/qmd api authentication          # BM25 search for "api authentication"
/qmd how to handle errors --semantic   # Vector search for conceptual query
/qmd --setup                     # Guide through initial setup

最佳实践

• 使用BM25 搜索(qmd search) 来查找特定术语、名称或技术关键词
• 使用向量搜索(qmd vsearch) 来查找可能用词不一的概念
• 除非需要最大召回率，否则避免使用混合搜索——它速度较慢
• 在添加大量新内容后，重新运行qmd embed以保持向量最新

处理参数

• $ARGUMENTS包含完整的搜索查询
• 如果--semantic标志存在，则使用qmd vsearch而非qmd search
• 如果--setup标志存在，则引导用户完成安装和集合设置
• 如果--collection <名称>已指定，则使用该集合；否则默认检查可用集合

工作流程

1. 从$ARGUMENTS
2. 解析参数检查 qmd 是否已安装 (which qmd
3. )
4. 若未安装，则提供引导设置
   • 如果正在搜索：
   • 运行适当的搜索命令
   • 向用户展示结果，并附上文件路径
5. 如果用户想要读取特定结果，请使用读取工具打开该文件路径