Skip to content

QUERY_GUIDE.md

Latest commit

 

History

History
346 lines (241 loc) · 6.75 KB

QUERY_GUIDE.md

File metadata and controls

346 lines (241 loc) · 6.75 KB

Get 笔记素材查询工具使用说明

📋 工具列表

1. query_materials.py - Python 查询工具

完整的 Python 命令行工具，支持自定义参数。

2. query.sh - 快捷查询脚本

预配置的 shell 脚本，自动加载环境变量。

🚀 快速使用

方法 1: 使用 Shell 脚本（推荐）

cd ~/.claude/skills/wechat-burst-gen

# 基本查询
./query.sh "职场效率"

# 指定分类
./query.sh "AI技术" -c 科技

# 返回更多结果
./query.sh "时间管理" -n 10

# 查看详细信息
./query.sh "职场沟通" -c 职场 -v

方法 2: 直接使用 Python

# 需要先设置环境变量
export GETNOTE_API_KEY="your_api_key"
export GETNOTE_KB_ID="your_kb_id"

# 查询
python query_materials.py "职场效率" -c 职场 -n 5

方法 3: 临时指定凭证

python query_materials.py "职场效率" \
  --api-key "your_api_key" \
  --kb-id "your_kb_id" \
  -c 职场

📊 输出格式

简洁模式（默认）

✅ 找到 3 条相关素材

【1】 中美AI软实力发展对比研究报告-鼎惟咨询-2025.12-139页
     类型: FILE | 相关度: 0.3944
     预览: 观点4-AI对教育/就业的影响...

【2】 AI时代的工作系统重构
     类型: NOTE | 相关度: 0.0630
     预览: 新方式（效率提升10倍）...

💡 使用 -v 参数查看详细信息

详细模式（-v 参数）

======================================================================
【素材 1】
======================================================================

📌 标题: 中美AI软实力发展对比研究报告-鼎惟咨询-2025.12-139页

📊 元信息:
   • 类型: FILE
   • 相关度: 0.5649
   • 来源: Get笔记-FILE

📝 内容预览:
   设施进行"对冲" 中美AI竞争是政策、资本、人才等全维度的举国...
   （显示前300字符）

🔑 ID: /0pymt7RmjTBq1M/27wLQg==

🎯 使用场景

场景 1: 写文章前查找素材

# 准备写职场效率的文章，先查看知识库有什么素材
./query.sh "职场效率提升" -c 职场 -n 5 -v

# 查看详细内容后，决定使用这些素材生成文章
python main.py "2025年职场效率提升指南" -c 职场

场景 2: 评估知识库内容

# 检查某个主题的素材数量和质量
./query.sh "AI技术" -c 科技 -n 10

# 如果素材不足，可以先在 Get 笔记中添加相关内容

场景 3: 快速查阅参考

# 快速查看某个话题的知识库内容
./query.sh "时间管理技巧" -v

# 用于日常学习和知识回顾

📖 参数说明

必需参数

  • query: 搜索关键词或主题

可选参数

  • -c, --category: 分类（职场/生活/科技等）

    • 帮助提高搜索精度
    • 示例: -c 职场

  • -n, --limit: 返回结果数量，默认 5

    • 范围: 1-20
    • 示例: -n 10

  • -v, --verbose: 显示详细信息

    • 包含完整的内容预览
    • 显示素材 ID

  • --api-key: Get 笔记 API Key

    • 优先级高于环境变量
    • 用于临时指定凭证

  • --kb-id: 知识库 ID

    • 优先级高于环境变量
    • 用于切换不同知识库

💡 使用技巧

技巧 1: 组合不同关键词

# 太宽泛
./query.sh "效率"

# 更精确 ✅
./query.sh "工作效率提升方法" -c 职场

技巧 2: 调整结果数量

# 快速浏览
./query.sh "AI" -n 3

# 全面了解
./query.sh "AI" -n 20

技巧 3: 利用相关度排序

# 结果按相关度从高到低排序
# 前几条通常是最相关的
./query.sh "职场沟通" -n 10

# 如果前3条相关度都很低（<0.1），说明知识库缺少该主题内容

技巧 4: 结合分类筛选

# 不指定分类 - 返回所有类型
./query.sh "效率"

# 指定分类 - 更精准 ✅
./query.sh "效率" -c 职场

🔍 理解搜索结果

相关度评分

  • >0.5: 非常相关，直接使用
  • 0.3-0.5: 较相关，可作为参考
  • 0.1-0.3: 弱相关，可能有部分有用信息
  • <0.1: 不相关，可能只是碰巧包含关键词

素材类型

  • FILE: PDF、文档等文件

    • 通常包含研究报告、行业分析
    • 内容较长，信息密度高

  • NOTE: 笔记内容

    • 你在 Get 笔记中整理的内容
    • 通常较精炼

  • BLOGGER: 博主文章、直播内容

    • 来自订阅的博主
    • 实时性较强

📝 完整示例

示例 1: 准备写职场文章

# 步骤 1: 查询素材
./query.sh "职场新人成长" -c 职场 -n 5 -v

# 步骤 2: 查看结果，评估素材质量
# 假设找到 3 条相关度 >0.4 的素材

# 步骤 3: 生成文章（自动使用这些素材）
python main.py "职场新人如何快速成长" -c 职场 -w 1800

# 步骤 4: 查看生成的文章
open output/article_*.html

示例 2: 探索知识库内容

# 查看 AI 相关素材
./query.sh "AI" -c 科技 -n 10

# 查看时间管理相关
./query.sh "时间管理" -c 职场 -n 10

# 查看生活类素材
./query.sh "健康" -c 生活 -n 10

示例 3: 批量查询多个主题

# 创建查询脚本
cat > batch_query.sh <<'EOF'
#!/bin/bash

topics=(
  "职场效率"
  "AI技术"
  "时间管理"
  "沟通技巧"
  "个人成长"
)

for topic in "${topics[@]}"; do
  echo "查询: $topic"
  ./query.sh "$topic" -c 职场 -n 3
  echo ""
  sleep 2
done
EOF

chmod +x batch_query.sh
./batch_query.sh

⚙️ 配置说明

环境变量配置

在 config/getnote.env:

GETNOTE_API_KEY=your_api_key_here
GETNOTE_KB_ID=your_kb_id_here

自定义快捷命令

在 ~/.zshrc 或 ~/.bashrc 中添加:

# Get 笔记查询别名
alias qm='~/.claude/skills/wechat-burst-gen/query.sh'

# 使用示例
qm "职场效率"
qm "AI技术" -c 科技 -v

🛠️ 故障排查

问题: 未找到相关素材

可能原因:

  1. 知识库中确实没有相关内容
  2. 关键词不匹配
  3. 分类筛选过严

解决方法:

# 1. 尝试更通用的关键词
./query.sh "效率" 而不是 "职场效率提升方法"

# 2. 去掉分类筛选
./query.sh "效率" 而不是 ./query.sh "效率" -c 职场

# 3. 增加返回数量
./query.sh "效率" -n 20

问题: 相关度都很低

解决方法:

  1. 在 Get 笔记中添加相关素材
  2. 使用 --no-getnote 参数纯 AI 生成
  3. 尝试不同的关键词

问题: API 连接失败

检查:

# 检查环境变量
echo $GETNOTE_API_KEY
echo $GETNOTE_KB_ID

# 测试连接
python mcp_tools/getnote.py

# 查看配置文件
cat config/getnote.env

📚 相关文档

快速开始使用 Get 笔记素材查询吧！ 🔍✨