Skip to content

docs: feature lists describe the catalogue that actually ships #419

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

Merged
argszero merged 1 commit into from
Oct 18, 2026
Merged

docs: feature lists describe the catalogue that actually ships #419

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ AITokenPool is an open-source **AI token sharing platform / multi-model gateway*
## Features

- **Multi-protocol gateway** — bidirectional conversion between OpenAI Chat / OpenAI Responses / Anthropic Messages, for both non-streaming and SSE streaming requests; clients only need one OpenAI-compatible endpoint
- **Transparent billing** — every call shows an input / cache-hit / output token breakdown; built-in DeepSeek official CNY pricing with peak-hour pricing support
- **Transparent billing** — every call shows an input / cache-hit / output token breakdown; vendor price lists ship with the release, each recorded in its own currency (CNY / USD), with peak-hour pricing support
- **Point system** — daily gift, 90/10 sharing split, admin top-up, self-registration with email verification
- **Enterprise controls** — departments, member credits, usage reports, and a dedicated operator view
- **Security** — upstream keys encrypted with AES-256-GCM, argon2 password hashing, email verification, admin role isolation
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ AITokenPool 是一个开源的 **AI Token 共享平台 / 多模型网关**：把
## 特性

- **多协议网关互转** — OpenAI Chat / OpenAI Responses / Anthropic Messages 三协议双向转换，非流式 + SSE 流式全支持；客户端只需对接一个 OpenAI 兼容端点
- **透明计费** — 每次调用展示「输入 / 缓存命中 / 输出」三档 token 明细；内置 DeepSeek 官方 CNY 定价，支持高峰时段计价
- **透明计费** — 每次调用展示「输入 / 缓存命中 / 输出」三档 token 明细；价目随发行预置，各厂商按原币记价（人民币 / 美元），支持高峰时段计价
- **点数体系** — 每日赠送、共享分成（90/10）、管理员加额、自助注册 + 邮箱验证
- **企业管控** — 部门管理、成员点数、用量报表、运营者视图，成本一目了然
- **安全** — 上游 Key AES-256-GCM 加密存储、argon2 密码哈希、邮箱验证、管理员角色隔离
Expand Down
6 changes: 3 additions & 3 deletions docs/plan-api-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Base URL 统一由 AITokenPool 提供（`[server].public_url` 配置），设置

- 上游 key 在「共享管理」页上架（provider + plan + model + key + 额度 + 可用时段）
- 模型价格由 `config/config.example.toml` 的 `[[models]]` 定义（唯一真源，启动 seed 入 `models` 表）
- 内置 DeepSeek 官方 CNY 定价（含高峰时段价）；其余厂商可按同格式配置
- 支持的 provider：deepseek、zhipu(glm)、openai、anthropic、google、bytedance、minimax、aliyun 等（随 `[[models]]` 配置扩展，无需改代码）
- 各厂商价目已随 `config/config.example.toml` 预置（含高峰时段价）；新增厂商只需按同格式补 `[[models]]`，无需改代码
- 预置 provider：`deepseek`、`zhipu`、`aliyun-bailian`、`bytedance-ark`、`moonshot`、`minimax`、`openai`、`anthropic`、`google`、`xai`（随 `[[models]]` 配置扩展，无需改代码）

## 4. 模型目录

内置 DeepSeek / GLM / GPT / Claude / Gemini / 豆包 / MiniMax / 通义等模型，含 context window、vision 支持、缓存价与高峰价字段。**数量与明细以 `config/config.example.toml` 的 `[[models]]` 为唯一真源**（由 `src/catalog_gate.rs` 的 `MODEL_COUNT` 守卫，此处不抄写数字以免随之陈旧）。模型列表可经管理端「模型管理」页 CRUD（需 admin 角色）。
内置 DeepSeek / GLM / GPT / Claude / Gemini / 豆包 / Kimi / MiniMax / 通义 / grok 等模型，含 context window、vision 支持、缓存价与高峰价字段。**数量与明细以 `config/config.example.toml` 的 `[[models]]` 为唯一真源**（由 `src/catalog_gate.rs` 的 `MODEL_COUNT` 守卫，此处不抄写数字以免随之陈旧）。模型列表可经管理端「模型管理」页 CRUD（需 admin 角色）。
2 changes: 1 addition & 1 deletion docs/user-stories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
## 3. 能力清单（对照 README 特性）

- **多协议网关**：OpenAI Chat / Responses / Anthropic Messages + SSE 流式互转
- **透明计费**：输入 / 缓存命中 / 输出 token 明细；DeepSeek 官方 CNY 价；高峰时段计价
- **透明计费**：输入 / 缓存命中 / 输出 token 明细；各厂商价目按原币记（人民币 / 美元）；高峰时段计价
- **点数体系**：每日赠送、分享分成、管理员充值、自助注册 + 邮箱验证、找回密码
- **企业管控**：部门、成员点数、用量报表、运营者视图、模型管理 CRUD
- **安全**：上游 key AES-256-GCM 加密、argon2 哈希、角色隔离、主密钥机制
Expand Down
Loading