diff --git a/HanLin.md b/HanLin.md new file mode 100644 index 0000000..1bddb26 --- /dev/null +++ b/HanLin.md @@ -0,0 +1,151 @@ +--- + +## 翰林院篇:忆识核心与RAG系统 + +翰林院,是Amily2号的忆识核心,是真正的记忆中枢。它基于RAG(检索增强生成)技术,能让角色拥有可随时查阅、永不遗忘的知识库。 + +
+注意:本篇所有功能,均围绕着一个核心——将你的知识(无论是聊天记录、手动输入的文本,还是世界书条目)转化为向量数据,存入一个特殊的“忆识宝库”中。当你和角色对话时,系统会自动检索宝库中最相关的内容,注入到提示词中,让角色“记起”相关信息。 +
+ +--- + +### 1. 总览与核心开关 + +这里是翰林院的仪表面板,展示了核心状态并提供了最高权限的操作。 + +![总览界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/main_controls.png) +*
上图:翰林院总览区域
* + +| 配置项 | 说明 | +|---|---| +| **开启忆识检索之权** | **翰林院的总开关**。关闭后,所有检索和注入功能都将暂停,但不会影响向量化的录入。 | +| **忆识总数** | 显示当前角色忆识宝库中存储的向量总数。旁边的**刷新**按钮可以手动更新这个数字。 | +| **清空宝库** | **(危险操作)** 一键删除当前角色**所有**的忆识。此操作不可逆,三思而后行。 | +| **存档封印** | 保存你在翰林院界面所做的所有设置。虽然大多数设置是即时生效的,但点击一下总没错。
Ps:其实`1.1.7`版本后基本没卵用了。 | + +> **附加说明**:忘记给刷新按钮增加自动刷新了,最好选择角色之后手动刷新一下。 + +--- + +### 2. 忆识检索 (Retrieval) + +这里负责配置连接外部“神力之源”(Embedding API)的通道,它是将文字转化为向量的根本。 + +![忆识检索界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/retrieval_main.png) +*
上图:忆识检索配置区域
* + +| 配置项 | 说明 | +|---|---| +| **API设定** | 选择你的Embedding服务商。如果你有自己的中转或特殊服务……也得`自定义`,毕竟其他的东西没完善。 | +| **自定义路径** | 当`API设定`为`自定义`时,在此处填写你的完整API地址。 | +| **通行令牌 (API Key)** | 你的Embedding API密钥。 | +| **嵌入模型** | 你想使用的Embedding模型。点击`获取模型`按钮可以自动从API拉取可用模型列表。 | +| **测试神力** | 点击后会尝试用你填写的配置连接API,检查是否能成功“沟通”。 | +| **重置为初** | 将此页面的所有设置恢复到最初的默认状态。 | + +>
重要提示:此处的API与主殿的API是**完全独立**的。主殿API负责聊天,翰林院API负责将知识向量化。两者可以相同,也可以不同。
+ +--- + +### 3. 书库编纂 (Historiography) + +这里是向忆识宝库中“录入”向量的地方,提供了多种方式。 + +#### 凝识法则 +这是最常用的功能,可以将你们的聊天记录转化为忆识(向量)。 + +![凝识法则界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/Shukubianzhuan.png) +*
上图:凝识法则配置区域
* + +| 配置项 | 说明 | +|---|---| +| **准许凝识** | 此功能的总开关(我一直开着的,不知道关了它之后录入还好不好使。) | +| **凝识范围** | 设定要转换的聊天记录楼层范围。例如,1-10就是转换最早的10条消息。 | +| **消息来源** | 选择要转换谁说的话,是你,还是AI,还是两者都要。 | +| **标签提取** | 一个高级功能,可以让你只提取消息中特定XML标签里的内容进行转换,可单可多,可预览编辑,但标签顺序要一致。 | +| **开始凝识** | 点击后,立刻根据以上设定,将聊天记录录入忆识宝库。 | +| **预览内容** | 在不实际录入的情况下,查看根据当前设定会生成哪些文本内容。 | + +#### 手动录入 & 按条目编纂 + + + +![手动与按条目编纂](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/condensation_manual_ingest.png) + + +![手动与按条目编纂](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/condensation_by_entry.png) +*
上图:手动录入与按条目编纂区域
* + +| 功能区 | 说明 | +|---|---| +| **手动录入** | 在文本框里粘贴任何你想要角色记住的文字(比如角色设定、背景故事),然后点击`开始录入`,即可存入宝库。 | +| **按条目编纂** | 可以直接选择一个**世界书**及其中的**条目**,将其内容整个录入忆识宝库。对于已经整理好的知识非常方便。 | + +> **附加说明**:没事不要加太多东西,酒馆向量库炸了你不炸了吗。 + +--- + +### 4. 忆识精炼 (Rerank) + +当检索到的忆识过多时,Rerank功能可以对初步检索结果进行二次排序,选出与当前对话**最最相关**的几条,大大提高知识注入的精准度。 + +![忆识精炼界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/rerank_main.png) +*
上图:Rerank配置区域
* + +| 配置项 | 说明 | +|---|---| +| **启用 Rerank** | 此功能的总开关。 | +| **Rerank API 地址/Key/模型** | 和Embedding API一样,你需要一个专门的Rerank模型服务。配置方法完全相同。 | +| **返回结果数 (top_n)** | Rerank之后,最终返回多少条最相关的忆识。 | +| **混合分数权重 (Alpha)** | 一个高级参数,用于平衡原始相似度分数和Rerank分数。保持默认的0.7通常效果最好。 | +| **Rerank 时上奏** | 开启后,每次成功执行Rerank都会在聊天框里发一条通知。 | + +> **附加说明**:听说这东西的提示词挺重要,但是我还没加。而且LLM的实现方式有点复杂,我慢慢整吧还是。 + +--- + +### 5. 高级设定 + +这里提供了一些微调参数,让你对翰林院的行为有更精细的控制。 + +![高级设定界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/advanced_settings_1.png) +*
上图:检索微调区域
* + +| 配置项 | 说明 | +|---|---| +| **书卷尺寸 (Chunk Size)** | 在录入知识时,将长文本切分成的小块的大小。这会影响检索的粒度。 | +| **上下文关联度 (Overlap)** | 每个小块之间重叠的字符数,以确保上下文的连续性。 | +| **忆识匹配度 (Threshold)** | 只有相似度高于这个阈值的忆识才会被检索出来。 | +| **检索参考的消息数量** | 系统会拿最近几条消息作为“问题”去检索忆识宝库。 | +| **单次检索最大结果数** | 在Rerank之前,初步从向量库中捞出多少条相关的忆识。 | + +> **附加说明**:没有附加说明,就单纯不想写。 + +--- + +#### 圣言注入 +这里决定了检索到的忆识,将以何种方式“告诉”给角色。 + +![圣言注入界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/advanced_settings_injection.png) +*
上图:圣言注入配置区域
* + +| 配置项 | 说明 | +|---|---| +| **圣言模板** | 注入内容的格式。`{{text}}`是占位符,会被实际的忆识内容替换,占位符不要乱改。
但是上面的提示词可以随意改,例如:“这里是已发生过事情中的相关记忆片段,请以以下内容作为参考:{{text}}。”像是这样。 | +| **注入位置** | 决定了这段“圣言”放在提示词的哪个位置。`聊天内 @ 深度`是最常用的,可以模拟一条特定角色的历史消息。 | + +--- + +### 6. 起居注 + +这里是翰林院的运行日志,记录了每一次知识录入、检索、注入的详细过程。如果遇到问题,来这里看看,通常能找到原因。 + +![起居注界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/log_view.png) +*
上图:起居注区域
* + +> **附加说明**:翰林院的教程就到这里了。这玩意很强大,但也需要耐心调教。多试试不同的设置,找到最适合你和你的角色的用法吧。 +> +>
重要提示:但要是有关翰林院的报错,你还给我截图红色框框,你看我把不把你头打爆。
+ +--- diff --git a/NeiGe.md b/NeiGe.md new file mode 100644 index 0000000..bb34f5d --- /dev/null +++ b/NeiGe.md @@ -0,0 +1,74 @@ +--- + +## 内阁密室篇:史册守护与手动敕史 + +内阁密室是Amily2的幕后机构,赋予你对聊天记录的绝对掌控权,无论是自动隐藏、手动管理,还是将对话熔铸为永恒的史册,都在这进行。 + +
+注意:这里的很多功能,特别是“手动敕史局”,都和主殿的“世界书”设置联动,不清楚的话可以先回去看看主殿的教程。 +
+ +--- + +### 1. 皇家史册管理员 & 手动敕令司 + +这两个放一起说,因为它们干的都是同一件事:**隐藏聊天记录**。只不过一个是自动的,一个是手动的。 + +![史册与敕令](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/neige_part1.png) +*
上图:自动与手动隐藏功能区
* + +| 配置项 | 说明 | +|---|---| +| **启用自动隐藏** | 开了之后,Amily2会在后台帮你隐藏旧的聊天记录,防止上下文爆炸。 | +| **保留最新消息层数** | 就是字面意思,用下面的滑块设置要保留多少条新消息,剩下的旧消息会被自动隐藏。 | +| **全部可见** | 一键让你看到所有被隐藏的消息,简单粗暴。 | +| **手动隐藏/取消** | 精准操作,想隐藏哪几楼,或者想把哪几楼放出来,自己填数字就行。 | + +>
+> 重要提示:可能会与其他隐藏聊天记录的插件冲突。 +>
+ +--- + +### 2. 手动敕史局 - 微言录 (Small Summary) + +这里是进行快速、批量化总结的地方。你可以把一段对话,甚至整个聊天记录,熔铸成一小段精华,存进世界书。 + +![微言录](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/neige_part2_small_summary.png) +*
上图:微言录功能区
* + +| 配置项 | 说明 | +|---|---| +| **选择编辑的谕旨** | 和主殿一样,让你在“破限”和“总结”两个提示词之间切换,决定这次总结任务的性质。 | +| **谕旨编辑区** | 给你个地方微调提示词,记得改完要**保存**,然后就是我们微言录的总结多少有点太详细,可以改一改。 | +| **手动熔铸范围** | 跟手动隐藏一样,填范围,点“熔铸”,搞定。 | +| **开始远征** | 重量级功能。点一下,它会把**所有**还没被总结过的聊天记录,按照下面的“远征阈值”分批次,一次性全给你总结了。 | +| **自动巡录** | 打开之后聊天时在后台自动帮你总结。 | +| **写入史册** | 意思就是存不存进世界书,后来我发现这个按钮是必开的。 | +| **存入翰林院** | 开了上面的写入史册按钮之后,这个存入翰林院就能起到作用了,自动向量化。那么问题来了,既然我都总结了,为什么还要向量化?既然我都向量化了为什么还要总结?
所以当你选择存入翰林院时,主殿一定要选择存入独立档案。 | +| **远征阈值** | “开始远征”和“自动巡录”都是分批干活的,这里就是设置每一批处理多少条消息。 | + +> **附加说明**:这里的“写入史册”和“存入翰林院”开关,直接决定了总结内容的去向,非常关键。 +> **重要提示**:旧卡先开始远征,否则自动总结可能会把你几百楼的消息一起发给副模型,直接让副模型炸掉了。 + +--- + +### 3. 手动敕史局 - 宏史卷 (史册精炼) + +“微言录”是从0到1,创造新的总结。“宏史卷”则是从1到100,把你已经存在世界书里的条目,拿出来让副模型重新精炼、润色、扩写。 + +![宏史卷](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/neige_part3_large_summary.png) +*
上图:宏史卷功能区
* + +| 配置项 | 说明 | +|---|---| +| **谕旨编辑区** | 和微言录一样,编辑这次“精炼”任务的提示词。 | +| **目标国史馆** | 先选一个世界书。 | +| **待精炼的史册条目** | 选好世界书之后,再在这里选择具体要精炼哪一条。 | +| **开始精炼** | 开始精炼之前,你要思考一件事,这个东西会把所有小总结的记录覆盖下去,所以我推荐你,先备份小总结。 | + +> **附加说明**:没有附加说明。 + +--- + +**最后提示**:微言录和宏史卷非常吃破限词,不然出现429、上游分组、UN、500等报错,基本都是**`破限失败`**。而预设提示词写得好,能给你把白开水润色成茅台;写不好,也可能把茅台给你整成白开水。 diff --git a/ZhuDian.md b/ZhuDian.md new file mode 100644 index 0000000..7fffa5f --- /dev/null +++ b/ZhuDian.md @@ -0,0 +1,108 @@ +--- + +## 主殿篇:核心功能与配置 + +主殿集合了大多数的功能,也连接了很多其他位置的功能,这里是最核心的地方。 +注意:翰林院内阁密室两个按钮不是摆设,那是其他功能界面的入口。 + +
+注意:翰林院、内阁密室两个按钮不是摆设,那是其他功能界面的入口。 +
+ + +--- + +### 1. API 配置 + +正确配置 API 是使用所有功能的第一步,你需要填写的核心信息如下: + +![API配置界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/Api.png) +*
上图:Api配置区域的示例图
* + +| 配置项 | 说明 | 示例 | +|---|---|---| +| **API 地址** | 本地或云端模型服务端口地址。 | `http://localhost:3000/v1` | +| **API 密钥** | API密钥这里我不过多做解释。
Claw是`json`的完整内容。 | `sk-xxxxxxxxxx` | +| **模型选择** | 你想使用的模型,个人推荐flash之类的。
毕竟它做的只是优化功能。 | `gpt-4-turbo` | +| **核心参数** | **最大Token数:** 发送给`副模型`的最大tokens的限制数量,一般我直接拉满。
**思考活跃度 **:调整`副模型`输出的创造性与确定性。值越高,回答越随机;值越低,回答越固定。
**上下文参考**:在进行优化或者即时总结的时候,发送给`副模型`的上下文参考数量,一般两三条。 | `20000`/`1.1`/`2` | + +>
重要提示:如果你使用的是中转,则无需勾选代理。如果使用的是谷歌模型、轮询等,则需要勾选强制代理!
+> 附加说明:实在连接不上的话,我推荐你先去试试你在酒馆直连是否可用。 + +--- + +### 2. 核心功能 + +![核心功能界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/Hexingongneng.png) +*
上图:核心功能区域的示例图
* + +| 配置项 | 说明 | +| ------------ | ------------------------------------------------------------ | +| **启动优化** | 优化功能的开关。核心逻辑是在主模型给你发送消息时,副模型进行拦截 | +| **即时总结** | 即时总结的意思是一条消息一总结,写进世界书里面,类似摘要。 | +| **优化标签** | 特定`一个`进行优化的标签,比如说你想让优化的文本标签是`content`那么你就要填入`content`。 | +| **无感优化** | 每次优化之后不执行刷新,直接替换文本,代价是不能开流式传输。 | +| **刷新优化** | 兼容性更强,但代价是替换文本之后会重载一下聊天页面。 | + +> **附加说明**:这东西,优化与总结是可以同时进行的。 + +--- + +--- + +### 3. 统一提示词编辑器 + +正文优化与即时总结的可自定义提示词。 +![统一提示词界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/Tishici.png) + +*
上图:统一提示词编辑器区域的示例图
* + +| 配置项 | 说明 | +| -------------- | ------------------------------------------------------------ | +| **破限提示词** | tmd好烦啊我真不想写了 | +| **预设提示词** | 对于正文优化时,对副模型的提示词,`仅对优化功能有效`。 | +| **总结提示词** | 仅对即时总结有效。 | +| **格式提示词** | 目前留空,不使用它。如果日后我再启动了全文优化或者多标签优化,可能会再次启用 | +| **扩展编辑器** | 右上角那个按钮不是摆设,自定义编辑的时候,方便一些。 | + +> **附加说明**:记得保存。 + +--- + +### 4.世界书、档案司与律法 + +这是插件的知识库核心,用于存储和管理角色的背景信息。Amily2可以读取世界书内容作为优化的参考,并将总结写入其中。 + +![世界书配置界面](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/worldbook_section.png) +*
上图:世界书配置区域的示例图
* + +| 配置项 | 说明 | +| -------------- | ------------------------------------------------------------ | +| **连接世界书** | 这东西我不推荐开,因为副模型只是做优化或者总结的工作,连不连接无所谓。 | +| **主世界书** | 当前你所选角色卡所绑定的主世界书。 | +| **独立档案** | 总结之后新建一个世界书,写到新建的世界书里面,一般是以`Amily2`开头。 | +| **激活模式** | 这个东西,我能不解释吗,写这个教程真的很烦。 | +| **确认敕令** | 其实它是个摆设,主殿的功能除了提示词以外都是自动保存的,这个按钮只为了好看。 | + +> **附加说明**:这里的设置,也控制着内阁密室的微言录。 +> **重要提示**:当进行写入工作时,世界书的UI中不要选择那个正在被写入的世界书。 + +--- + +### 5. 界面定制 + +这里……我qnm的吧这看不懂还玩什么酒馆删除吧! + +![界面定制](https://cdn.jsdelivr.net/gh/Wx-2025/ST-Amily2-images@main/images/Fujia.png) + +*
上图:界面定制区域的示例图
* + +| 配置项 | 说明 | +| ------------ | ------------------------------------------------------------ | +| **驻扎顶栏** | 插件的入口会在UI顶界面。 | +| **收归扩展** | 插件的入口会在扩展里面和其他的一样在里面躺尸。 | +| **诊断操作** | 其实这俩按钮没啥大作用,点击报错的时候能让我多收集一点信息。 | + +> **附加说明**:emmm主殿似乎终于写完了,告辞,下个页面见兄弟。 + +---