mirror of https://github.com/Mai-with-u/MaiBot.git
6.1 KiB
6.1 KiB
Mai NEXT Todo list
version 0.3.0 - 2026-01-11
配置文件设计
- 使用
toml作为配置文件格式 合理使用注释说明当前配置作用(提案)- 使用 python 方法作为配置项说明(提案)
- 取消
bot_config_template.toml - 取消
model_config_template.toml - 取消
template_env
- 取消
- 配置类中的所有原子项目应该只包含以下类型:
str,int,float,bool,list,dict,set- 禁止使用
Union类型 - 禁止使用
tuple类型,使用嵌套dataclass替代 - 复杂类型使用嵌套配置类实现
- 禁止使用
- 配置类中禁止使用除了
model_post_init的方法 - 取代了部分与标准函数混淆的命名
id->item_id
BotConfig 设计
- 精简了配置项,现在只有Nickname和Alias Name了(预期将判断提及移到Adapter端)
ChatConfig
- 迁移了原来在
ChatConfig中的方法到一个单独的临时类TempMethodsHFC中- _parse_range
- get_talk_value
- 其他上面两个依赖的函数已经合并到这两个函数中
ExpressionConfig
- 迁移了原来在
ExpressionConfig中的方法到一个单独的临时类TempMethodsExpression中- get_expression_config_for_chat
- 其他上面依赖的函数已经合并到这个函数中
ModelConfig
- 迁移了原来在
ModelConfig中的方法到一个单独的临时类TempMethodsLLMUtils中- get_model_info
- get_provider
数据库模型设计
仅保留要点说明
General Modifications
- 所有项目增加自增编号主键
id - 统一使用了SQLModel作为基类
- 复杂类型使用JSON格式存储
- 所有时间戳字段统一命名为
timestamp
消息模型 MaiMessage
- 自增编号主键
id - 消息元数据
- 消息id
message_id - 消息时间戳
time - 平台名
platform - 用户元数据
- 用户id
user_id - 用户昵称
user_nickname - 用户备注名
user_cardname - 用户平台
user_platform
- 用户id
- 群组元数据
- 群组id
group_id - 群组名称
group_name - 群组平台
group_platform
- 群组id
- 被提及/at字段
- 是否被提及
is_mentioned - 是否被at
is_at
- 是否被提及
- 消息id
- 消息内容
- 原始消息内容
raw_content(base64编码存储) - 处理后的纯文本内容
processed_plain_text - 真正放入Prompt的消息内容
display_message
- 原始消息内容
- 消息内部元数据
- 聊天会话id
session_id - 回复的消息id
reply_to - 是否为表情包消息
is_emoji - 是否为图片消息
is_picture - 是否为命令消息
is_command - 是否为通知消息
is_notify
- 聊天会话id
- 其他配置
additional_config(JSON格式存储)
模型使用情况 ModelUsage
- 模型相关信息
- 请求相关信息
- Token使用情况
图片数据模型
- 图片元信息
- 图片哈希值
image_hash,使用sha256,同时作为图片唯一ID
- 图片哈希值
- 表情包的情感标签
emotion - 是否已经被注册
is_registered - 是否被手动禁用
is_banned - 被记录时间
record_time - 注册时间
register_time - 上次使用时间
last_used_time
动作记录模型 ActionRecord
命令执行记录模型 CommandRecord
新增此记录
在线时间记录模型 OnlineTime
表达方式模型
黑话模型
- 重命名
inference_content_only为inference_with_content_only
聊天记录模型
- 重命名
original_text为original_message - 重命名
forget_times为query_forget_count
细枝末节
- 统一所有的
stream_id和chat_id命名为session_id - 更换Hash方式为
sha256
流转在各模块间的数据模型设计
- 数据库交互
- 对有数据库模型的数据模型,创建统一的classmethod
from_db_model用于从数据库模型实例创建数据模型实例- 类型检查
- 对有数据库模型的数据模型,创建统一的method
to_db_model用于将数据模型实例转换为数据库模型实例
- 对有数据库模型的数据模型,创建统一的classmethod
- 标准化init方法
消息构建
- 更加详细的消息构建文档,详细解释混合类型,转发类型,指令类型的构建方式
- 混合类型文档
- 文本说明
- 代码示例
- 转发类型文档
- 文本说明
- 代码示例
- 指令类型文档
- 文本说明
- 代码示例
- 混合类型文档
表情包系统
- 移除大量冗余代码,全部返回单一对象MaiEmoji
- 使用C模块库提升相似度计算效率
- 移除了定时表情包完整性检查,改为启动时检查(依然保留为独立方法,以防之后恢复定时检查系统)
Prompt 管理系统
- 官方Prompt全部独立
- 用户自定义Prompt系统
- 用户可以创建,删除自己的Prompt
- 用户可以覆盖官方Prompt
- Prompt构建系统
- Prompt文件交互
- 读取Prompt文件
- 读取官方Prompt文件
- 读取用户Prompt文件
- 用户Prompt覆盖官方Prompt
- 保存Prompt文件
- 读取Prompt文件
- Prompt管理方法
- Prompt添加
- Prompt删除
- 只保存被标记为需要保存的Prompt,其他的Prompt文件全部删除
一些细枝末节的东西
- 将
stream_id和chat_id统一命名为session_id - 映射表
platform_group_user_session_id_map平台_群组_用户-会话ID映射表
- 将大部分的数据模型均以
Mai开头命名
细节说明
- Prompt管理系统中保存用户自定义Prompt的时候会只保存被标记为需要保存的Prompt,其他的Prompt文件会全部删除,以防止用户删除Prompt后文件依然存在的问题。因此,如果想在运行时通过修改文件的方式来添加Prompt,需要确保通过对应方法标记该Prompt为需要保存,否则在下一次保存时会被删除。