Files
goodbuddy-shareserver/docs/features/share-server/feature-list.md
T

260 lines
14 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# ShareServer 产品功能列表
## 文档用途
本文用于确定 ShareServer 的产品信息架构、页面范围和功能状态。功能按“模块、页面、Tab、功能”组织,页面结构先于功能细节确定。
状态含义如下:
| 状态 | 含义 |
| --- | --- |
| 已实现 | 代码和自动化验证已覆盖,范围以实施进度中的证据为准 |
| 部分实现 | 已有可运行功能,但生产验收或关键依赖尚未完成 |
| 设计中 | 已形成产品和技术设计,尚未作为生产功能交付 |
| 待规划 | 已进入产品方向,页面和接口仍需进一步确定 |
ShareServer 是 GoodBuddy 的独立组织后台。成员的日常操作主要在 GoodBuddy 中完成,ShareServer 负责设备目录、能力发布、授权、任务、模型网关、文档和审计等组织能力。当前仓库已经包含本地共享目录和真实转发的本地模型网关,生产身份、组织隔离、设备控制连接和工具执行尚未完成。
## 页面组织规则
- 一级导航按业务对象分组,页面只负责一个相对完整的管理对象。
- 页面内 Tab 按查看范围或操作阶段划分,不能把配置、运行记录和统计混在同一个 Tab。
- 列表、详情和创建表单属于同一 Tab 的交互,不单独扩成一级导航。
- Tab 名称使用产品对象或用户任务命名,避免使用“其他”“更多功能”等收纳式名称。
- 当前未接入的 Tab 可以进入,但必须显示待接入边界,不生成示例数据,也不提供不会生效的操作。
## 信息架构总览
| 一级模块 | 页面 | Tab | 当前状态 |
| --- | --- | --- | --- |
| 工作台 | 运行概览 | 服务状态、待处理事项、最近活动 | 部分实现 |
| GoodBuddy 服务 | 模型网关 | 概览、上游服务、模型目录、访问密钥、请求测试、调用审计、客户端接入 | 部分实现 |
| GoodBuddy 服务 | 文档与协作 | 文档库、编辑会话、Office 服务、保存记录 | 待接入 |
| GoodBuddy 服务 | 配置下发 | 配置草稿、设备生效、发布记录、回滚记录 | 待接入 |
| 共享资源 | GoodBuddy 接入 | 设备列表、设备详情、连接记录、撤销记录 | 部分实现 |
| 共享资源 | 共享中心 | 能力目录、共享知识库、按成员查看、按设备查看 | 部分实现 |
| 共享资源 | 数字人 | 数字人目录、我的数字人、调用权限、发布记录 | 设计中 |
| 组织管理 | 组织与成员 | 成员、用户组、角色、服务账号 | 设计中 |
| 组织管理 | 权限策略 | 强制策略、Grant、策略模拟、变更记录 | 设计中 |
| 组织管理 | 审批 | 待处理、已处理、我的申请、审批规则 | 设计中 |
| 组织管理 | 发布与更新 | 能力包、发布通道、更新策略、撤销记录 | 设计中 |
| 组织管理 | 网关联邦 | 合作组织、待确认、开放范围、事件记录 | 设计中 |
| 运营与审计 | 任务与中继 | 任务列表、活动任务、中继连接、运行统计 | 设计中 |
| 运营与审计 | 审计 | 事件查询、调用链、导出任务、保留策略 | 部分实现 |
| 系统 | 系统设置 | 实例信息、身份与登录、基础设施、中继与联邦、通知、保留与审计 | 设计中 |
| 成员自助 | 我的设备与授权 | 我的设备、我的授权、我的申请、我的数字人 | 设计中 |
## 1. 工作台
### 1.1 运行概览
| Tab | 内容 | 状态 |
| --- | --- | --- |
| 服务状态 | ShareServer、GoodBuddy 设备、模型上游和共享目录的关系;设备登记数、启用上游数和启用模型数 | 部分实现 |
| 待处理事项 | 待审批、失败任务、保存失败、连接异常和紧急撤销 | 设计中 |
| 最近活动 | 最近的注册、发布、网关调用、授权和任务事件 | 设计中 |
当前页面只展示真实 API 返回的服务拓扑和入口,不生成预设指标或活动记录。
## 2. GoodBuddy 服务
### 2.1 模型网关
模型网关为 GoodBuddy 和兼容客户端提供统一的模型请求入口。网关保存上游配置和模型映射,转发请求并记录有界调用元数据,不托管模型,也不在网关执行模型返回的工具调用。
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 概览 | 网关地址、启用上游数、启用模型数、访问密钥数、最近调用状态和管理边界 | 部分实现 |
| 上游服务 | 添加、编辑、启停上游;保存 Base URL、协议和认证方式;凭据留空则保留,填写则覆盖;发现远端模型 | 部分实现 |
| 模型目录 | 查看模型别名、远端模型名、所属上游和启用状态;手工添加或编辑映射;启停映射 | 部分实现 |
| 访问密钥 | 创建客户端 Bearer Key;按模型绑定授权范围;查看名称和状态;撤销密钥 | 部分实现 |
| 请求测试 | 选择可用模型发送真实非流式请求;显示结果;取消请求;提示数据去向和费用风险 | 部分实现 |
| 调用审计 | 查看时间、请求编号、模型、上游、访问密钥、流式方式、结果、HTTP 状态、耗时、Token 用量和错误码 | 部分实现 |
| 客户端接入 | 查看客户端 Base URL、协议、模型 ID 和配置步骤;说明客户端只使用网关访问 Key | 部分实现 |
模型网关的页面关系如下:
```text
概览
├─ 上游服务 管理外部模型服务连接
├─ 模型目录 管理客户端可见的模型映射
├─ 访问密钥 管理客户端调用凭据和模型授权
├─ 请求测试 验证模型请求转发
├─ 调用审计 查看调用结果和运行元数据
└─ 客户端接入 将已配置模型交给 GoodBuddy 或兼容客户端使用
```
网关后续扩展仍放在对应 Tab:
- 上游服务增加健康状态、延迟和错误率。
- 模型目录增加能力标签、路由规则和备用上游。
- 访问密钥增加主体、组织、有效期、配额和撤销原因。
- 请求测试增加工具调用和流式场景的受控验证。
- 调用审计增加 `traceId`、父子请求、决策、失败阶段和链路详情。
- 客户端接入增加按组织或用户组分发配置的能力。
组织身份、工具级权限、三态策略、供应商切换、配额、成本统计和工具执行属于后续网关能力,不能写成当前 Tab 已提供的操作。
### 2.2 文档与协作
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 文档库 | 主存文档、归属、版本、保留规则和检索 | 待接入 |
| 编辑会话 | 活动会话、访问模式、checkpoint、保存状态和过期处理 | 待接入 |
| Office 服务 | Document Server、回调、存储和健康检查 | 待接入 |
| 保存记录 | 服务端保存、结果未知、失败重试和本地源文件回写状态 | 设计中 |
首期 Office 范围为浏览器上传 DOCX、编辑、保存和重新打开。XLSX、PPTX、Desktop 文档 Tab 和本地回写属于后续范围。
### 2.3 配置下发
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 配置草稿 | 按客户端、设备或成员组编排模型和服务配置 | 待接入 |
| 设备生效 | 查看目标设备、应用版本、生效状态和失败原因 | 待接入 |
| 发布记录 | 查看配置版本、发布时间、发布者和影响范围 | 待接入 |
| 回滚记录 | 记录回滚请求、目标版本和设备确认结果 | 待接入 |
保存模型网关配置不会自动创建配置下发记录。
## 3. 共享资源
### 3.1 GoodBuddy 接入
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 设备列表 | 查询设备名称、平台、应用版本、登记时间和发布数量 | 部分实现 |
| 设备详情 | 查看登记信息、发布记录和来源声明 | 部分实现 |
| 连接记录 | 查看在线状态、出站控制连接和最近心跳 | 设计中 |
| 撤销记录 | 撤销设备、停止新任务和查看历史撤销原因 | 设计中 |
当前实现支持本地设备登记元数据和真实发布目录查询;生产设备认证、在线状态、出站 WebSocket 和任务控制待实现。
### 3.2 共享中心
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 能力目录 | 能力名称、版本、来源设备、发布状态和可见范围 | 部分实现 |
| 共享知识库 | 知识来源模式,以及搜索、读取原文、下载三项权限声明 | 部分实现 |
| 按成员查看 | 按成员查看可发现、可检查和可调用的资源 | 设计中 |
| 按设备查看 | 按提供设备查看已发布能力、知识和撤销记录 | 部分实现 |
当前共享中心只处理发布元数据,不提供知识正文、能力执行或真实授权。
### 3.3 数字人
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 数字人目录 | 按 `@handle`、所有者、Runtime、版本和可用范围查询 | 设计中 |
| 我的数字人 | 创建发布草稿、选择 Agent、设置开放范围、提交审批和撤销 | 设计中 |
| 调用权限 | 查看当前成员的发现、检查、调用权限和审批要求 | 设计中 |
| 发布记录 | 查看版本、状态、权限变化和撤销原因 | 设计中 |
## 4. 组织管理
### 4.1 组织与成员
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 成员 | 邀请、停用、移除和查看成员设备、授权与申请 | 设计中 |
| 用户组 | 管理成员组、设备组和组内授权范围 | 设计中 |
| 角色 | 管理组织管理员、发布者、审批人和审计员 | 设计中 |
| 服务账号 | 管理自动化调用主体、凭据、权限和有效期 | 设计中 |
### 4.2 权限策略
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 强制策略 | 组织级禁止规则、数据范围、出站地址和风险限制 | 设计中 |
| Grant | 将主体、资源、动作、有效期和预算绑定为授权 | 设计中 |
| 策略模拟 | 输入主体、资源和动作,查看命中规则与最终决策 | 设计中 |
| 变更记录 | 查看策略版本、变更者、影响范围和撤销结果 | 设计中 |
策略决策使用三种结果:自动允许、人工确认、直接拒绝。工具权限应落到具体动作,例如查询允许、修改需确认、删除拒绝。
### 4.3 审批
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 待处理 | 按调用、发布、更新和联邦申请筛选待审批项 | 设计中 |
| 已处理 | 查看批准、拒绝、过期和撤销的申请 | 设计中 |
| 我的申请 | 查看本人提交的申请和当前状态 | 设计中 |
| 审批规则 | 设置审批人、风险条件和批量审批范围 | 设计中 |
### 4.4 发布与更新
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 能力包 | 上传、验证、查看 manifest、签名、版本和兼容范围 | 设计中 |
| 发布通道 | 按设备组、组织和发布范围安排版本 | 设计中 |
| 更新策略 | 设置审批、自动更新、灰度和失败处理规则 | 设计中 |
| 撤销记录 | 紧急撤销版本、查看影响设备和后续任务处理 | 设计中 |
### 4.5 网关联邦
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 合作组织 | 查看对端地址、指纹、连接状态和有效期 | 设计中 |
| 待确认 | 创建、接受或拒绝联邦 offer | 设计中 |
| 开放范围 | 分别查看我方开放、对方开放和最终可用的资源集合 | 设计中 |
| 事件记录 | 查看建立、暂停、恢复、撤销和调用事件 | 设计中 |
## 5. 运营与审计
### 5.1 任务与中继
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 任务列表 | 按调用方、能力、提供者、路由、状态和时间查询任务 | 设计中 |
| 活动任务 | 查看排队、运行、等待确认、取消和结果未知的任务 | 设计中 |
| 中继连接 | 查看活动连接、吞吐、容量和拒绝原因 | 设计中 |
| 运行统计 | 查看延迟、失败率、取消率和提供者状态 | 设计中 |
### 5.2 审计
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 事件查询 | 按操作者、动作、对象、组织、结果、时间和关联 ID 查询 | 设计中 |
| 调用链 | 查看模型、工具、任务、路由和最终结果的父子事件 | 设计中 |
| 导出任务 | 创建、查看和下载有时效的审计导出 | 设计中 |
| 保留策略 | 设置事件、正文、工具参数和模型输出的保留范围 | 设计中 |
当前模型网关已经保存有界调用元数据。完整组织审计、调用链、导出和保留策略仍未实现。
## 6. 系统
### 6.1 系统设置
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 实例信息 | 实例名称、公开地址、协议版本和部署信息 | 设计中 |
| 身份与登录 | 本地账号、OIDC、Web 会话、CSRF 和会话撤销 | 设计中 |
| 基础设施 | 数据库、对象存储、证书、版本和服务状态 | 设计中 |
| 中继与联邦 | 中继开关、容量限制、联邦总开关和证书 | 设计中 |
| 通知 | 邮件、审批提醒、失败告警和通知渠道 | 设计中 |
| 保留与审计 | 全局保留规则、归档和审计导出限制 | 设计中 |
运行时秘密、数据库连接串、主密钥和容器挂载路径由部署环境提供,系统设置只显示状态或执行替换与测试。
## 7. 成员自助
### 7.1 我的设备与授权
| Tab | 主要功能 | 当前状态 |
| --- | --- | --- |
| 我的设备 | 管理本人设备、连接状态和设备撤销 | 设计中 |
| 我的授权 | 查看本人获得的能力、模型、工具、有效期和限制 | 设计中 |
| 我的申请 | 创建调用、发布和权限申请,查看处理结果 | 设计中 |
| 我的数字人 | 管理本人创建的数字人及其发布范围 | 设计中 |
成员的日常协作、消息、资料同步和能力调用主要在 GoodBuddy 中完成,Web 端提供授权、申请和发布管理入口。
## 当前交付边界
当前仓库可以运行的功能集中在两个页面域:
1. GoodBuddy 接入和共享中心:保存并读取本地设备登记、能力发布和知识发布元数据。
2. 模型网关:保存上游、加密凭据、模型映射和访问 Key,支持真实模型发现、请求转发、请求测试和有界调用审计。
组织认证、组织隔离、生产设备认证、设备控制连接、工具执行、任务路由、文档保存、Office 编辑、实时协作、成本控制和联邦仍属于设计或后续实现范围。接口、状态规则和验证证据分别由 [PRD](./prd.md)、[功能逻辑](./logic-design.md)、[技术设计](./technical-design.md) 和 [实施进度](./progress.md) 维护。