Skip to content

docs(examples): highlight local-only examples #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wananing wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(examples): highlight local-only examples #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@
uv run python examples/basic/pipeline_file.py # 零外部依赖，推荐首选
```

## 无需外部服务的示例

下面这些示例不需要 OceanBase、LLM API key 或后台服务，适合作为第一次运行的入口。
如果输出里出现 `SUMMARIZER_PROVIDER not configured` warning，表示示例正在使用本地
L0 内容回退，这是本地零配置模式下的预期行为。

| 示例 | 命令 | 预期行为 |
|---|---|---|
| `basic/pipeline_file.py` | `uv run python examples/basic/pipeline_file.py` | 写入 3 条本地文件后端数据，并打印每个查询命中的 item id |
| `basic/langchain.py` | `uv run python examples/basic/langchain.py` | 演示 LangChain Memory / Retriever 桥接，并打印 retrieved documents 与 memory history |
| `advanced/research_agent.py` | `uv run python examples/advanced/research_agent.py` | 跑完整研究 Agent 演示，最后打印 `DEMO COMPLETE` 与条目统计 |
| `advanced/evidence_chain.py` | `uv run python examples/advanced/evidence_chain.py` | 构建证据链 DAG，并打印 upstream、confidence 与冲突信息 |
| `advanced/powermem_minimal.py` | `uv run python examples/advanced/powermem_minimal.py` | 使用内置 mock PowerMem 记录，打印导入的 memory |
| `advanced/powermem_plug.py` | `USE_POWERMEM=mock uv run python examples/advanced/powermem_plug.py` | 强制使用 mock PowerMem 数据，展示 DataPlug 导入和统一检索 |

## [advanced/](advanced/) — 完整能力展示

涵盖 LLM 集成、演进流水线、DataPlug 扩展。
Expand Down
Loading