Wiki Notes

Appearance

AI Wiki ​

中文 AI 应用开发知识库，包含连续的系统教程、可运行 Python 示例和按领域组织的参考专题。

阅读入口 ​

  • 学习首页：主线课程和问题导航。
  • 系统教程：从核心概念、模型调用到检索、工具循环与评测。
  • 基础导读：前置知识、阅读顺序与练习标准。

运行示例 ​

在本仓库根目录执行：

bash
cd examples/doc_assistant
python -X utf8 call.py
python -X utf8 retrieval.py "如何构建文档"
python -X utf8 agent.py "如何构建文档"
python -X utf8 evaluate.py
python -X utf8 -m unittest -v

需要 Python 3.10 或以上版本，无额外依赖。默认离线运行；真实调用需要显式增加 --live 并配置环境变量，详细步骤见教程。离线演示不代表真实模型效果。

内容结构 ​

实战教程/ 提供连续任务；examples/doc_assistant/ 保存对应代码与样例数据。其他目录作为基础、LLM、模型、检索、Agent、多模态、平台、安全、评测与历史等领域的参考资料。完整分类只在学习首页维护。

维护约定 ​

  1. 教程正文必须包含任务、输入与输出、运行步骤、失败情况和验收练习。
  2. 优先完善已有文章；新增专题前检查是否存在相同主题，避免复制长段概念说明。
  3. 代码放入 examples/，在教程里引用源码；修正示例后运行对应离线测试。
  4. 区分教学样例、模拟数据、人工预期答案和真实运行结果；API、价格、模型能力注明核对时间与一手来源。
  5. index.md 面向读者，README 面向维护者，不复制完整阅读目录。
  6. 本仓库作为 dispatch-docs 的 Git 子模块使用。发布时先提交并推送 AI Wiki 改动，再更新主仓库指针和导航；只提交主仓库不会包含尚未提交的子模块正文。

当前示例只在离线路径上验证，不包含认证、多租户隔离、持久化审计等生产能力。