Start AI knowledge base v2 workspace

ai_knowledge_base_v2/extracted/11-AI知识库系统字段字典_Data_Dictionary_V10.md

@@ -0,0 +1,264 @@
+# 11-AI知识库系统字段字典_Data_Dictionary_V1.0.xlsx
+
+## Sheet: 00_文档说明
+- Range: 30 rows x 6 columns
+
+| 11-AI知识库系统字段字典（Data Dictionary） |  |  |  |  |  |
+| 文档名称 | 11-AI知识库系统字段字典（Data Dictionary） |  |  |  |  |
+| 版本 | V1.0 |  |  |  |  |
+| 项目名称 | AI 企业知识库问答系统 |  |  |  |  |
+| 依据文档 | 数据库设计 V1.0 |  |  |  |  |
+| 适用版本 | V1.0 |  |  |  |  |
+| 第一章 文档说明 |  |  |  |  |  |
+| 1.1 编写目的 |  |  |  |  |  |
+| 字段字典用于统一数据库字段定义，避免开发、测试、运维及 BI 人员理解不一致。  所有新增数据表均需遵循本规范。 |  |  |  |  |  |
+| 工作表目录 |  |  |  |  |  |
+| 序号 | 工作表 | 内容 |  |  |  |
+| 1 | 01_通用字段规范 | 公共字段定义 |  |  |  |
+| 2 | 02_sys_user | 用户表字段 |  |  |  |
+| 3 | 03_sys_admin | 管理员表字段 |  |  |  |
+| 4 | 04_sys_knowledge | 知识库表字段 |  |  |  |
+| 5 | 05_sys_user_kb | 用户知识库权限表字段 |  |  |  |
+| 6 | 06_sys_chat_session | 聊天会话表字段 |  |  |  |
+| 7 | 07_sys_chat_message | 聊天消息表字段 |  |  |  |
+| 8 | 08_sys_prompt | Prompt 表字段 |  |  |  |
+| 9 | 09_sys_model | 模型配置表字段 |  |  |  |
+| 10 | 10_sys_system_config | 系统配置表字段 |  |  |  |
+| 11 | 11_sys_ai_request_log | AI 请求日志字段 |  |  |  |
+| 12 | 12_sys_operation_log | 操作日志表字段 |  |  |  |
+| 13 | 13_字段取值规范 | 状态、删除标识、消息状态取值 |  |  |  |
+| 14 | 14_命名维护规范 | 表命名、字段命名及维护规范 |  |  |  |
+
+## Sheet: 01_通用字段规范
+- Range: 10 rows x 4 columns
+
+| 第二章 通用字段规范 |  |  |  |
+| 所有业务表建议包含以下公共字段 |  |  |  |
+| 字段 | 类型 | 是否必填 | 说明 |
+| id | BIGINT | √ | 主键 |
+| created_at | DATETIME | √ | 创建时间 |
+| updated_at | DATETIME | √ | 更新时间 |
+| created_by | BIGINT | × | 创建人（管理员） |
+| updated_by | BIGINT | × | 修改人（管理员） |
+| is_deleted | TINYINT | √ | 逻辑删除标识（0=否，1=是） |
+
+## Sheet: 02_sys_user
+- Range: 17 rows x 6 columns
+
+| 第三章 用户表字段（sys_user） |  |  |  |  |  |
+| 表名：sys_user |  |  |  |  |  |
+| 字段 | 类型 | 长度 | 必填 | 默认值 | 说明 |
+| id | BIGINT | - | √ | 自增 | 主键 |
+| phone | VARCHAR | 20 | √ | - | 手机号（唯一） |
+| name | VARCHAR | 50 | √ | - | 姓名 |
+| nickname | VARCHAR | 50 | × | NULL | 昵称 |
+| status | TINYINT | - | √ | 1 | 账号状态 |
+| daily_chat_limit | INT | - | √ | 100 | 每日聊天额度 |
+| daily_chat_used | INT | - | √ | 0 | 今日已使用次数 |
+| effective_at | DATETIME | - | × | NULL | 生效时间 |
+| expired_at | DATETIME | - | × | NULL | 到期时间 |
+| last_login_at | DATETIME | - | × | NULL | 最后登录时间 |
+| created_at | DATETIME | - | √ | 当前时间 | 创建时间 |
+| updated_at | DATETIME | - | √ | 当前时间 | 更新时间 |
+| is_deleted | TINYINT | - | √ | 0 | 是否删除 |
+
+## Sheet: 03_sys_admin
+- Range: 13 rows x 3 columns
+
+| 第四章 管理员表字段（sys_admin） |  |  |
+| 表名：sys_admin |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| username | VARCHAR(50) | 登录账号 |
+| password | VARCHAR(255) | 加密密码 |
+| name | VARCHAR(50) | 姓名 |
+| role_id | BIGINT | 角色ID |
+| status | TINYINT | 状态 |
+| last_login_at | DATETIME | 最后登录时间 |
+| created_at | DATETIME | 创建时间 |
+| updated_at | DATETIME | 更新时间 |
+
+## Sheet: 04_sys_knowledge
+- Range: 12 rows x 3 columns
+
+| 第五章 知识库表字段（sys_knowledge） |  |  |
+| 表名：sys_knowledge |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| name | VARCHAR(100) | 知识库名称 |
+| feishu_space_id | VARCHAR(100) | 飞书 Space ID |
+| feishu_node_id | VARCHAR(100) | 飞书节点 ID |
+| status | TINYINT | 启用/禁用 |
+| remark | VARCHAR(255) | 备注 |
+| created_at | DATETIME | 创建时间 |
+| updated_at | DATETIME | 更新时间 |
+
+## Sheet: 05_sys_user_kb
+- Range: 12 rows x 3 columns
+
+| 第六章 用户知识库权限表（sys_user_kb） |  |  |
+| 表名：sys_user_kb |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| user_id | BIGINT | 用户ID |
+| knowledge_id | BIGINT | 知识库ID |
+| effective_at | DATETIME | 生效时间 |
+| expired_at | DATETIME | 到期时间 |
+| created_by | BIGINT | 创建管理员 |
+| created_at | DATETIME | 创建时间 |
+| updated_at | DATETIME | 更新时间 |
+
+## Sheet: 06_sys_chat_session
+- Range: 12 rows x 3 columns
+
+| 第七章 聊天会话表（sys_chat_session） |  |  |
+| 表名：sys_chat_session |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| user_id | BIGINT | 用户ID |
+| title | VARCHAR(100) | 会话标题 |
+| message_count | INT | 消息数量 |
+| last_message_at | DATETIME | 最后消息时间 |
+| is_deleted | TINYINT | 是否删除 |
+| created_at | DATETIME | 创建时间 |
+| updated_at | DATETIME | 更新时间 |
+
+## Sheet: 07_sys_chat_message
+- Range: 15 rows x 3 columns
+
+| 第八章 聊天消息表（sys_chat_message） |  |  |
+| 表名：sys_chat_message |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| session_id | BIGINT | 会话ID |
+| user_id | BIGINT | 用户ID |
+| role | ENUM | user / assistant |
+| content | LONGTEXT | 消息内容 |
+| message_status | VARCHAR(20) | 消息状态 |
+| token_input | INT | 输入 Token |
+| token_output | INT | 输出 Token |
+| response_time_ms | INT | 回复耗时（毫秒） |
+| model_id | BIGINT | 模型ID |
+| created_at | DATETIME | 创建时间 |
+
+## Sheet: 08_sys_prompt
+- Range: 8 rows x 3 columns
+
+| 第九章 Prompt 表（sys_prompt） |  |  |
+| 表名：sys_prompt |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| prompt_content | LONGTEXT | Prompt 内容 |
+| updated_by | BIGINT | 修改人 |
+| updated_at | DATETIME | 更新时间 |
+
+## Sheet: 09_sys_model
+- Range: 13 rows x 3 columns
+
+| 第十章 模型配置表（sys_model） |  |  |
+| 表名：sys_model |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| provider | VARCHAR(50) | 模型供应商 |
+| model_name | VARCHAR(100) | 模型名称 |
+| api_url | VARCHAR(255) | API 地址 |
+| api_key | TEXT | API 密钥 |
+| temperature | DECIMAL | 温度参数 |
+| max_token | INT | 最大输出 Token |
+| timeout_second | INT | 超时时间 |
+| enabled | TINYINT | 是否启用 |
+
+## Sheet: 10_sys_system_config
+- Range: 10 rows x 3 columns
+
+| 第十一章 系统配置表（sys_system_config） |  |  |
+| 表名：sys_system_config |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| config_key | VARCHAR(100) | 配置键 |
+| config_value | TEXT | 配置值 |
+| description | VARCHAR(255) | 描述 |
+| updated_by | BIGINT | 修改人 |
+| updated_at | DATETIME | 更新时间 |
+
+## Sheet: 11_sys_ai_request_log
+- Range: 19 rows x 3 columns
+
+| 第十二章 AI 请求日志（sys_ai_request_log） |  |  |
+| 表名：sys_ai_request_log |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| session_id | BIGINT | 会话ID |
+| message_id | BIGINT | 消息ID |
+| user_id | BIGINT | 用户ID |
+| model_name | VARCHAR(100) | 模型名称 |
+| prompt | LONGTEXT | Prompt 内容 |
+| knowledge_ids | VARCHAR(500) | 检索知识库 |
+| retrieve_count | INT | 命中文档数 |
+| input_token | INT | 输入 Token |
+| output_token | INT | 输出 Token |
+| total_token | INT | Token 总数 |
+| cost_ms | INT | 请求耗时 |
+| status | VARCHAR(20) | 请求状态 |
+| error_message | TEXT | 错误信息 |
+| created_at | DATETIME | 创建时间 |
+
+## Sheet: 12_sys_operation_log
+- Range: 14 rows x 3 columns
+
+| 第十三章 操作日志表（sys_operation_log） |  |  |
+| 表名：sys_operation_log |  |  |
+| 字段 | 类型 | 说明 |
+| id | BIGINT | 主键 |
+| admin_id | BIGINT | 管理员ID |
+| module | VARCHAR(50) | 操作模块 |
+| action | VARCHAR(50) | 操作类型 |
+| target_id | BIGINT | 操作对象ID |
+| before_json | LONGTEXT | 修改前数据 |
+| after_json | LONGTEXT | 修改后数据 |
+| ip | VARCHAR(50) | IP 地址 |
+| result | VARCHAR(20) | 操作结果 |
+| created_at | DATETIME | 创建时间 |
+
+## Sheet: 13_字段取值规范
+- Range: 20 rows x 6 columns
+
+| 第十四章 字段取值规范 |  |  |  |  |  |
+| status |  |  |  |  |  |
+| 值 | 含义 |  |  |  |  |
+| 0 | 禁用 |  |  |  |  |
+| 1 | 启用 |  |  |  |  |
+| is_deleted |  |  |  |  |  |
+| 值 | 含义 |  |  |  |  |
+| 0 | 正常 |  |  |  |  |
+| 1 | 已删除 |  |  |  |  |
+| message_status |  |  |  |  |  |
+| 值 | 含义 |  |  |  |  |
+| WAITING | 等待处理 |  |  |  |  |
+| GENERATING | 生成中 |  |  |  |  |
+| FINISHED | 已完成 |  |  |  |  |
+| STOPPED | 用户停止 |  |  |  |  |
+| TIMEOUT | 超时 |  |  |  |  |
+| FAILED | 失败 |  |  |  |  |
+
+## Sheet: 14_命名维护规范
+- Range: 21 rows x 6 columns
+
+| 第十五章 命名规范 / 第十六章 数据字典维护规范 |  |  |  |  |  |
+| 15.1 表命名 |  |  |  |  |  |
+| 规范项 | 内容 |  |  |  |  |
+| 统一格式 | sys_xxx |  |  |  |  |
+| 示例 | sys_user |  |  |  |  |
+| 示例 | sys_chat_message / sys_prompt |  |  |  |  |
+| 15.2 字段命名 |  |  |  |  |  |
+| 规范项 | 内容 |  |  |  |  |
+| 统一格式 | snake_case |  |  |  |  |
+| 示例 | created_at |  |  |  |  |
+| 示例 | updated_at / user_id |  |  |  |  |
+| 示例 | model_name |  |  |  |  |
+| 第十六章 数据字典维护规范 |  |  |  |  |  |
+| 序号 | 维护要求 |  |  |  |  |
+| 1 | 新增数据表必须同步更新字段字典。 |  |  |  |  |
+| 2 | 修改字段类型、长度或含义时，必须更新字段字典。 |  |  |  |  |
+| 3 | 字段字典应与数据库脚本保持一致，并纳入版本管理。 |  |  |  |  |
+| 4 | 建议同时维护 Excel 版本，供产品、开发、测试及运维共同使用。 |  |  |  |  |