Skip to content

GET_NOTE_GUIDE.md

Latest commit

 

History

History
359 lines (271 loc) · 7.21 KB

GET_NOTE_GUIDE.md

File metadata and controls

359 lines (271 loc) · 7.21 KB

Get 笔记集成使用指南

快速开始

1. 设置环境变量

# 在 ~/.zshrc 或 ~/.bashrc 中添加
export GETNOTE_API_KEY="ClFmzocjTPS3kA34PmKic3zsJYJ0M4gVbWzp68aLqnocWYFFTINy/htxISaZRuoTPaLmhAmbMrWEUFvvGIUStQHUHzVp+o8iQFpa"
export GETNOTE_KB_ID="707AGXvn"

# 重新加载配置
source ~/.zshrc

或者使用配置文件:

# 加载 Get 笔记配置
cd ~/.claude/skills/wechat-burst-gen
source config/getnote.env

2. 测试连接

# 测试 Get 笔记 API
python mcp_tools/getnote.py

预期输出:

🧪 测试 Get 笔记 API

📚 Get 笔记 API 已初始化
   知识库 ID: 707AGXvn

============================================================
测试 1: 连接测试
============================================================
🔍 正在从 Get 笔记召回: 测试连接 (top_k=1)
   ✅ 召回 1 条素材
✅ Get 笔记 API 连接正常

3. 生成带素材的文章

# 使用 Get 笔记素材生成文章
python main.py "如何提升职场竞争力" -c 职场 -s 商务

工作流程:

  1. 从 Get 笔记知识库搜索 "职场竞争力" 相关素材
  2. 将素材作为参考，用 AI 生成高质量文章
  3. 自动生成封面图和配图
  4. 生成微信排版 HTML
  5. 保存到飞书

4. 不使用 Get 笔记

如果不想使用 Get 笔记，可以跳过:

# 纯 AI 生成（不调用 Get 笔记）
python main.py "如何提升职场竞争力" -c 职场 --no-getnote

使用示例

示例 1: 职场主题

# 从知识库获取职场效率相关素材
python main.py "2025年职场效率提升指南" \
  -c 职场 \
  -s 商务 \
  -w 2000

Get 笔记会返回:

  • 相关的职场案例
  • 效率提升方法论
  • 行业研究报告片段
  • 专家观点引用

示例 2: 技术主题

# 从知识库获取 AI 相关素材
python main.py "AI 如何改变职场" \
  -c 科技 \
  -s 科技 \
  -w 1800

Get 笔记会返回:

  • AI 行业报告
  • 技术发展趋势
  • 应用案例
  • 专业分析

示例 3: 批量生成

# 创建选题列表
cat > topics_with_materials.txt <<EOF
职场新人如何快速成长
远程办公的时间管理技巧
如何建立个人知识体系
职场沟通的黄金法则
EOF

# 批量生成（每篇都会调用 Get 笔记）
python main.py --batch topics_with_materials.txt -c 职场 -s 简约

素材质量说明

Get 笔记返回的素材包括:

  1. 笔记内容 (NOTE)

    • 用户保存的笔记
    • 知识库整理的内容

  2. 文件内容 (FILE)

    • PDF 文档片段
    • 研究报告摘录

  3. 博主内容 (BLOGGER)

    • 订阅博主的文章
    • 直播内容记录

素材使用效果:

每条素材都带有:

  • 相关度评分: 0-1 之间，越高越相关
  • 标题: 素材标题
  • 内容: 素材正文
  • 来源类型: NOTE/FILE/BLOGGER

AI 会根据这些素材:

  • 提取关键观点
  • 引用数据案例
  • 增强文章可信度
  • 丰富内容深度

工作流程详解

步骤 1: 素材获取

【步骤 1/6】从 Get 笔记获取参考素材
🔍 正在从 Get 笔记召回: 职场领域关于职场效率提升的素材和案例 (top_k=5)
   ✅ 获取到 5 条参考素材

步骤 2: AI 生成

【步骤 2/6】生成文案内容
   ✅ 文章已生成
   标题: 职场效率提升的5个黄金法则
   字数: 1987

素材会被格式化为 AI prompt 的参考部分:

## 参考素材（来自 Get 笔记知识库）

### 素材 1: 中美AI软实力发展对比研究报告
内容: ...
元信息: 类型: FILE | 相关度: 0.418 | 来源: Get笔记-FILE

### 素材 2: ...

步骤 3-6: 图片、排版、保存

与之前流程相同

Python 集成示例

from mcp_tools.getnote import GetNoteAPI

# 创建客户端
client = GetNoteAPI(
    api_key="your_api_key",
    kb_id="707AGXvn"
)

# 方法 1: 获取主题素材（推荐）
materials = client.get_materials_for_topic(
    topic="职场效率提升",
    category="职场",
    limit=5
)

# 方法 2: 直接召回
raw_materials = client.recall(
    question="如何提升工作效率",
    top_k=5,
    intent_rewrite=True,
    select_matrix=True
)

# 方法 3: AI 搜索（需要更长超时时间）
result = client.search(
    question="如何提升职场竞争力",
    deep_seek=True,
    refs=True
)

# 格式化素材用于 AI
formatted = client.format_materials_for_prompt(materials)
print(formatted)

配置选项

在主程序中使用

from main import WeChatBurstGen

# 初始化时指定 Get 笔记配置
generator = WeChatBurstGen(
    getnote_api_key="your_api_key",
    getnote_kb_id="707AGXvn",
    style="简约",
    skip_getnote=False  # False 表示使用 Get 笔记
)

# 生成文章（自动调用 Get 笔记）
result = generator.generate_complete_article(
    topic="如何提升工作效率",
    category="职场",
    word_count=1500
)

跳过 Get 笔记

# 方法 1: 初始化时跳过
generator = WeChatBurstGen(
    skip_getnote=True  # 跳过 Get 笔记
)

# 方法 2: 不设置环境变量
# 如果没有设置 GETNOTE_API_KEY，会自动跳过

常见问题

Q: Get 笔记调用失败会怎样?

A: 程序会自动降级为纯 AI 生成，不会中断流程:

【步骤 1/6】从 Get 笔记获取参考素材
   ⚠️  获取素材失败: Connection timeout
   💡 将继续使用纯 AI 生成

【步骤 2/6】生成文案内容
   ✅ 文章已生成（纯 AI 模式）

Q: 如何提高素材相关度?

A: 在搜索时:

  1. 使用更具体的主题
  2. 指定正确的分类
  3. 在知识库中添加更多相关内容

Q: 素材会直接复制到文章吗?

A: 不会。素材只作为参考:

  • AI 会理解素材内容
  • 提取关键观点和数据
  • 用自己的语言重新组织
  • 确保原创性

Q: Get 笔记 API 有调用限制吗?

A: 根据你的 API 套餐而定。建议:

  • 批量生成时设置延时
  • 合理控制 top_k 参数
  • 监控 API 调用次数

最佳实践

1. 知识库维护

在 Get 笔记中:

  • 定期整理相关素材
  • 添加标签和分类
  • 保存高质量的行业报告、案例分析

2. 主题匹配

确保文章主题与知识库内容相关:

  • ✅ 好: 知识库有大量职场内容，生成职场文章
  • ❌ 差: 知识库全是技术内容，生成美食文章

3. 素材数量

建议设置:

  • 短文章 (1000字): top_k=3
  • 中等文章 (1500字): top_k=5
  • 长文章 (2000字+): top_k=7-10

4. 组合使用

最佳实践:

# 1. 从 Get 笔记获取素材
# 2. AI 结合素材生成内容
# 3. 保存到飞书进行人工审核
# 4. 发布前优化

python main.py "主题" -c 分类 -s 风格

故障排查

调试模式

在测试时查看详细输出:

# 运行测试脚本
python mcp_tools/getnote.py

# 查看召回的素材
python -c "
from mcp_tools.getnote import GetNoteAPI
client = GetNoteAPI()
materials = client.recall('测试主题', top_k=3)
for m in materials:
    print(f'{m[\"title\"]}: {m[\"score\"]:.3f}')
"

网络问题

如果遇到超时:

# 增加超时时间（在 getnote.py 中）
response = requests.post(
    endpoint,
    headers=self.headers,
    json=payload,
    timeout=60  # 从 30 增加到 60 秒
)

开始使用 Get 笔记提升你的文章质量吧！ 📚✨