API 参考
本章节集中提供 API 的“查表入口”和“源码级说明”。
阅读顺序
建议按以下顺序阅读：
endpoints.md：先了解 HTTP、SSE、WebSocket 路由全貌interface-contract.md：查看当前已实现的交互契约api-service.md、services.md与parsers.md：按对象深入阅读公开模型、核心服务和解析器storage.md、model-config.md、utils.md：按需查看存储、配置与通用组件
页面分工
| 页面类型 | 作用 | 维护方式 |
|---|---|---|
| 概览页 | 提供阅读顺序、入口导航和章节分工 | 手工维护 |
| 契约页 | 解释已实现协议、约定和边界 | 手工维护 |
| 对象页 | 展示公开类、函数和模型的源码级说明 | mkdocstrings 自动渲染 |
写作边界见 文档规范。
章节说明
- 端点概览：HTTP、SSE、WebSocket 路由清单
- 接口契约：请求与响应结构、协议约定和兼容边界
- API 服务：应用工厂、聊天请求模型和对外响应模型
- 核心服务：分块、嵌入、摄取、检索等公共 service 对象
- 解析器：解析接口、注册函数和内置 parser 对象
- 数据库与存储：ORM、MinIO、Qdrant 相关对象
- 工具与辅助：配置、日志、模型加载等通用组件
架构关系
- 架构总览见：系统架构
- Services 总览见：Services 模块概览
- 存储设计见：存储架构
- 数据模型见：数据模式与关系