docs: generalize client integration requirements
This commit is contained in:
1 parent
ae950e0b33
commit
0d3c33b363
3 files changed
+21
-23
No files matched your search
@@ -84,7 +84,7 @@ MaaS 模型服务与应用开发
|
|||||||
- 面向 C 端的首页、模型广场、模型详情和接入文档。
|
- 面向 C 端的首页、模型广场、模型详情和接入文档。
|
||||||
- 多家模型供应商接入及统一模型目录。
|
- 多家模型供应商接入及统一模型目录。
|
||||||
- 统一 API 外壳、API Key 和 SDK/示例接入方式。
|
- 统一 API 外壳、API Key 和 SDK/示例接入方式。
|
||||||
- Cherry Studio、Codex 和通用 OpenAI 客户端/SDK 的接入配置与联调。
|
- AI 应用、业务系统、开发工具和通用 SDK/HTTP 的接入配置与联调。
|
||||||
- 普通响应、流式响应和异步任务响应。
|
- 普通响应、流式响应和异步任务响应。
|
||||||
- 3D 生成等任务型模型的任务提交、进度查询、结果文件和失败处理。
|
- 3D 生成等任务型模型的任务提交、进度查询、结果文件和失败处理。
|
||||||
- 基础模型搜索、分类、能力标签、价格/额度说明和服务状态。
|
- 基础模型搜索、分类、能力标签、价格/额度说明和服务状态。
|
||||||
@@ -95,7 +95,7 @@ MaaS 模型服务与应用开发
|
|||||||
|
|
||||||
### 用户获得的体验
|
### 用户获得的体验
|
||||||
|
|
||||||
用户不需要分别购买和管理多个模型服务,也不需要为每个供应商单独开发接入逻辑,只需要把模亦灵枢的 Base URL、API Key 和模型名配置到代码、Cherry Studio 或兼容的开发工具中,即可开始调用多个类型的模型;对于 3D 生成等异步模型,还可以查询任务进度并获取生成结果。
|
用户不需要分别购买和管理多个模型服务,也不需要为每个供应商单独开发接入逻辑,只需要把模亦灵枢的 Base URL、API Key 和模型名配置到自己的 AI 系统、开发工具或 SDK/HTTP 客户端中,即可开始调用多个类型的模型;对于 3D 生成等异步模型,还可以查询任务进度并获取生成结果。
|
||||||
|
|
||||||
### 这一阶段的商业方向(待确认)
|
### 这一阶段的商业方向(待确认)
|
||||||
|
|
||||||
|
|||||||
@@ -84,19 +84,17 @@
|
|||||||
|
|
||||||
邀请机制是准入策略,不与具体登录凭证强绑定。账户和认证设计不能假设用户永远只能通过邀请码注册。
|
邀请机制是准入策略,不与具体登录凭证强绑定。账户和认证设计不能假设用户永远只能通过邀请码注册。
|
||||||
|
|
||||||
### 第三方客户端接入目标(已确认)
|
### 标准接口与开发工具接入目标(已确认)
|
||||||
|
|
||||||
首批用户不仅要能在平台页面调用模型,还要能把模亦灵枢作为模型提供商配置到第三方客户端和开发工具中。
|
首批用户不仅要能在平台页面调用模型,还要能把模亦灵枢作为模型服务配置到自己开发的 AI 系统、SDK、桌面工具、IDE 工具或其他支持自定义模型服务的客户端中。Cherry Studio、OpenCode、Codex 等只是可能的使用例子,不构成产品绑定或唯一验收对象。
|
||||||
|
|
||||||
| 客户端类型 | 第一版目标 | 关键兼容项 |
|
| 使用方式 | 第一版目标 | 通用兼容项 |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| Cherry Studio | 作为明确验收客户端完成真实模型调用 | Base URL、API Key、模型列表/模型名、Chat Completions、SSE 流式响应和标准错误 |
|
| AI 应用或业务系统 | 应用可以使用平台 Key 调用模型并追踪用量 | Base URL、Bearer API Key、模型标识、版本化 API、错误和用量 |
|
||||||
| Codex | 作为明确目标客户端完成自定义模型提供商联调 | 自定义 provider、Base URL、环境变量 API Key、Responses API、流式事件和工具调用 |
|
| 桌面/网页/IDE 类工具 | 用户可以在工具中填入平台连接信息并完成调用 | Base URL、Key、模型名、协议选择、流式响应和超时/重试 |
|
||||||
| 通用 OpenAI SDK/客户端 | 提供可复制的配置和示例 | Bearer 鉴权、版本化 API、模型标识、Chat Completions/Responses 和错误语义 |
|
| SDK 或 HTTP 直接接入 | 提供可复制的配置和多语言示例 | 模型列表、同步/流式/异步协议、标准鉴权、错误语义和请求 ID |
|
||||||
|
|
||||||
根据 [OpenAI Codex 配置参考](https://developers.openai.com/codex/config-reference),Codex 支持自定义 `model_providers`、`base_url` 和从环境变量读取 API Key;自定义提供商当前使用 `responses` 协议。因此,模亦灵枢若要成为 Codex 的模型提供商,第一版需要把 Responses API 兼容列为实际联调范围,而不能只实现 Chat Completions。
|
第一版验收按“至少一种 AI 应用或业务系统 + 至少一种支持自定义模型服务的工具 + 一种 SDK/HTTP 方式”覆盖,不按具体品牌验收。兼容层不强制所有模型使用对话协议:文本/代码模型优先提供通用对话接口,3D、视频、音频等模型继续使用类型化任务接口,并在模型详情中明确支持的协议。
|
||||||
|
|
||||||
兼容层不强制所有模型使用对话协议:文本/代码模型优先提供 OpenAI 兼容接口,3D、视频、音频等模型继续使用类型化任务接口,并在模型详情中明确支持的协议。
|
|
||||||
|
|
||||||
### 并发、排队与任务规则
|
### 并发、排队与任务规则
|
||||||
|
|
||||||
@@ -223,7 +221,7 @@
|
|||||||
| UR-010 | 运营人员希望控制不同模型和供应商的资源 | 模型/供应商并发、速率、队列和资源配额 | P1 | 可按模型和供应商查看并调整容量策略 |
|
| UR-010 | 运营人员希望控制不同模型和供应商的资源 | 模型/供应商并发、速率、队列和资源配额 | P1 | 可按模型和供应商查看并调整容量策略 |
|
||||||
| UR-011 | 内测用户需要通过受控方式进入平台 | 邀请码注册、邀请记录和账号状态 | P0 | 只有有效邀请码可以完成注册,管理员可追踪使用情况 |
|
| UR-011 | 内测用户需要通过受控方式进入平台 | 邀请码注册、邀请记录和账号状态 | P0 | 只有有效邀请码可以完成注册,管理员可追踪使用情况 |
|
||||||
| UR-012 | 用户需要在没有支付系统时获得可用额度 | 管理员额度发放、额度流水和控制台额度展示 | P0 | 管理员发放后用户可调用,所有变更均有可追踪记录 |
|
| UR-012 | 用户需要在没有支付系统时获得可用额度 | 管理员额度发放、额度流水和控制台额度展示 | P0 | 管理员发放后用户可调用,所有变更均有可追踪记录 |
|
||||||
| UR-013 | 用户希望在常用客户端中直接使用平台 Key | 客户端兼容 API、接入指南和联调测试 | P0 | Cherry Studio 与 Codex 使用模亦灵枢 Base URL、Key 和模型完成目标调用 |
|
| UR-013 | 用户希望在自己的 AI 系统或开发工具中直接使用平台 Key | 标准接口、接入指南和兼容性测试 | P0 | 至少一种 AI 应用/业务系统、一种开发工具和一种 SDK/HTTP 方式可以使用模亦灵枢 Base URL、Key 和模型完成目标调用 |
|
||||||
|
|
||||||
### 产品演进需求
|
### 产品演进需求
|
||||||
|
|
||||||
@@ -254,7 +252,7 @@
|
|||||||
↓
|
↓
|
||||||
复制平台 Base URL、API Key、模型名和客户端配置
|
复制平台 Base URL、API Key、模型名和客户端配置
|
||||||
↓
|
↓
|
||||||
在 Cherry Studio、Codex 或代码中完成第一次模型调用
|
在 AI 应用、开发工具或代码中完成第一次模型调用
|
||||||
↓
|
↓
|
||||||
查看用量、额度和调用结果
|
查看用量、额度和调用结果
|
||||||
```
|
```
|
||||||
@@ -354,7 +352,7 @@
|
|||||||
|
|
||||||
- 总览:额度、今日用量、请求/任务概况、快速开始和服务状态。
|
- 总览:额度、今日用量、请求/任务概况、快速开始和服务状态。
|
||||||
- API Key:创建、查看、禁用和轮换 Key。
|
- API Key:创建、查看、禁用和轮换 Key。
|
||||||
- 客户端接入:展示 Base URL、API Key、模型名、协议选择和 Cherry Studio/Codex/SDK 配置说明。
|
- 标准接入:展示 Base URL、API Key、模型名、协议选择和不同类型客户端/SDK 的配置说明。
|
||||||
- 模型广场:登录后直接试用模型、查看调用示例或创建 Key。
|
- 模型广场:登录后直接试用模型、查看调用示例或创建 Key。
|
||||||
- Playground:在线测试模型,完成从体验到代码调用的过渡。
|
- Playground:在线测试模型,完成从体验到代码调用的过渡。
|
||||||
- 调用日志与用量:按时间、模型和 Key 查看请求、资源消耗和错误。
|
- 调用日志与用量:按时间、模型和 Key 查看请求、资源消耗和错误。
|
||||||
@@ -504,7 +502,7 @@
|
|||||||
- API Key 创建和禁用。
|
- API Key 创建和禁用。
|
||||||
- Base URL、模型名和 API Key 的客户端接入说明。
|
- Base URL、模型名和 API Key 的客户端接入说明。
|
||||||
- 统一模型调用入口。
|
- 统一模型调用入口。
|
||||||
- 面向 Chat Completions 和 Responses 的目标兼容接口,并完成 Cherry Studio 与 Codex 联调验证。
|
- 面向通用对话和任务协议的目标兼容接口,并完成 AI 应用、开发工具和 SDK/HTTP 三类接入验证。
|
||||||
- 支持同步、流式和异步任务三种调用模式。
|
- 支持同步、流式和异步任务三种调用模式。
|
||||||
- 基础速率限制、并发限制、队列状态和超时处理。
|
- 基础速率限制、并发限制、队列状态和超时处理。
|
||||||
- 首批模型清单至少覆盖文本/多模态能力,并预留或接入 AI 生成 3D 模型能力。
|
- 首批模型清单至少覆盖文本/多模态能力,并预留或接入 AI 生成 3D 模型能力。
|
||||||
@@ -571,7 +569,7 @@
|
|||||||
- 内部业务首次接入流程可以从配置凭证走到第一次调用。
|
- 内部业务首次接入流程可以从配置凭证走到第一次调用。
|
||||||
- 外部开发者首次使用流程可以从邀请码注册走到第一次调用。
|
- 外部开发者首次使用流程可以从邀请码注册走到第一次调用。
|
||||||
- 管理员可以发放额度,用户可以看到额度流水并使用额度完成调用。
|
- 管理员可以发放额度,用户可以看到额度流水并使用额度完成调用。
|
||||||
- 用户可以复制 Base URL、API Key 和模型名,在 Cherry Studio 和目标 Codex 配置中完成联调验收。
|
- 用户可以复制 Base URL、API Key 和模型名,在 AI 应用、开发工具或 SDK/HTTP 接入中完成联调验收。
|
||||||
- 模型目录、API Key、用量和账务记录之间的关系清楚,具体价格规则可暂时留空。
|
- 模型目录、API Key、用量和账务记录之间的关系清楚,具体价格规则可暂时留空。
|
||||||
- 同步、流式和异步任务型模型的核心流程可以分别说明。
|
- 同步、流式和异步任务型模型的核心流程可以分别说明。
|
||||||
- 并发限制、排队、超时、取消、重试和容量不足时的行为可以说明。
|
- 并发限制、排队、超时、取消、重试和容量不足时的行为可以说明。
|
||||||
@@ -621,14 +619,14 @@
|
|||||||
| 项目与 Key | 是否支持项目级 Key、权限、预算、并发和模型白名单 | 待填写,建议预留 |
|
| 项目与 Key | 是否支持项目级 Key、权限、预算、并发和模型白名单 | 待填写,建议预留 |
|
||||||
| 管理员权限 | 用户、模型、供应商、账务、风控、审计的角色边界 | 待填写 |
|
| 管理员权限 | 用户、模型、供应商、账务、风控、审计的角色边界 | 待填写 |
|
||||||
|
|
||||||
### C.1 第三方客户端接入
|
### C.1 标准接口与开发工具接入
|
||||||
|
|
||||||
| 待填写项 | 需要确认的内容 | 当前状态 |
|
| 待填写项 | 需要确认的内容 | 当前状态 |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| Cherry Studio | 支持的协议、Base URL 格式、模型名、流式和错误展示 | 第一版明确验收 |
|
| AI 应用/业务系统 | Base URL、Key、模型名、协议、错误和用量回传 | 第一版明确验收 |
|
||||||
| Codex | `model_providers`、Base URL、环境变量 Key、Responses API、流式事件和工具调用 | 第一版目标,按目标版本实际联调 |
|
| 开发工具/客户端 | 自定义模型服务、流式、超时、重试和工具调用能力 | 第一版至少选择一种实际联调 |
|
||||||
| 通用 SDK | OpenAI 兼容 Chat Completions、Responses、模型列表、鉴权和错误码 | 第一版明确提供 |
|
| 通用 SDK/HTTP | 模型列表、鉴权、同步/流式/异步接口和错误码 | 第一版明确提供 |
|
||||||
| 配置文档 | 各客户端的填写项、示例、常见错误和安全提示 | 第一版必须提供 |
|
| 配置文档 | 不同接入方式的填写项、示例、常见错误和安全提示 | 第一版必须提供 |
|
||||||
|
|
||||||
### D. 地区、数据与合规评估
|
### D. 地区、数据与合规评估
|
||||||
|
|
||||||
|
|||||||
@@ -94,7 +94,7 @@
|
|||||||
- 把需求拆成 P0、P1、P2 优先级。
|
- 把需求拆成 P0、P1、P2 优先级。
|
||||||
- 明确功能需求和非功能需求。
|
- 明确功能需求和非功能需求。
|
||||||
- 明确首版的并发、延迟、排队、超时、可用性和任务完成时间等关键质量目标;容量数字可以先记录为假设。
|
- 明确首版的并发、延迟、排队、超时、可用性和任务完成时间等关键质量目标;容量数字可以先记录为假设。
|
||||||
- 明确首版准入方式、额度发放方式和目标第三方客户端兼容范围。
|
- 明确首版准入方式、额度发放方式和标准接口/开发工具兼容范围。
|
||||||
- 建立“用户需求—产品功能—验收标准—测试用例”的追踪关系。
|
- 建立“用户需求—产品功能—验收标准—测试用例”的追踪关系。
|
||||||
- 评审正常流程、异常流程、业务闭环和跨系统影响。
|
- 评审正常流程、异常流程、业务闭环和跨系统影响。
|
||||||
- 编写 MVP 范围与验收标准。
|
- 编写 MVP 范围与验收标准。
|
||||||
@@ -108,7 +108,7 @@
|
|||||||
- 功能清单和优先级。
|
- 功能清单和优先级。
|
||||||
- 业务规则说明。
|
- 业务规则说明。
|
||||||
- 非功能需求和容量假设。
|
- 非功能需求和容量假设。
|
||||||
- 第三方客户端兼容矩阵和接入验收标准。
|
- 标准接口与开发工具兼容矩阵和接入验收标准。
|
||||||
- MVP 验收标准。
|
- MVP 验收标准。
|
||||||
- 需求评审记录。
|
- 需求评审记录。
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user