From c3ddb3289e7c2739b855ebb837ac37262ac12b3f Mon Sep 17 00:00:00 2001 From: dingyi Date: Tue, 7 Nov 2023 19:39:39 +0800 Subject: [PATCH] chore: rename `chathub` to `chatluna` --- .../hugging-face-embeddings.md | 4 +-- .../configure-embedding-model/introduction.md | 8 +++--- docs/guide/getting-started.md | 26 +++++++++---------- docs/guide/introduction.md | 2 +- docs/guide/preset-system/share-preset.md | 4 +-- docs/guide/preset-system/switch-preset.md | 6 ++--- docs/guide/preset-system/write-preset.md | 14 +++++----- docs/guide/useful-configurations.md | 4 +-- docs/index.md | 2 +- 9 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/guide/configure-embedding-model/hugging-face-embeddings.md b/docs/guide/configure-embedding-model/hugging-face-embeddings.md index 91ea3759..b011dd7e 100644 --- a/docs/guide/configure-embedding-model/hugging-face-embeddings.md +++ b/docs/guide/configure-embedding-model/hugging-face-embeddings.md @@ -6,7 +6,7 @@ Hugging Face 平台是一个模型的开源分享相关平台。 甚至还可使用 Hugging Face 平台提供的 API 来直接使用这些模型。 Hugging Face 社区提供了大量的模型，其中就包括了一些嵌入模型。 -在 ChatHub 中也提供了 Hugging Face 的 API 接入，让我们可以直接使用 Hugging Face 平台所拥有的嵌入模型。 +在 ChatLuna 中也提供了 Hugging Face 的 API 接入，让我们可以直接使用 Hugging Face 平台所拥有的嵌入模型。 ## 使用 @@ -22,6 +22,6 @@ Hugging Face 社区提供了大量的模型，其中就包括了一些嵌入模 6. 启用嵌入模型服务插件。 -7. 执行一次 `chathub.embeddings.list` 指令，然后寻找有 `huggingface/` 前缀的嵌入模型。 +7. 执行一次 `chatluna.embeddings.list` 指令，然后寻找有 `huggingface/` 前缀的嵌入模型。 8. 设置默认使用的嵌入模型为上一步找到的嵌入模型。如果你直接使用了默认的嵌入模型，那么就应该是 `huggingface/sentence-transformers/distilbert-base-nli-mean-tokens`。 diff --git a/docs/guide/configure-embedding-model/introduction.md b/docs/guide/configure-embedding-model/introduction.md index 78e93dbc..10767bff 100644 --- a/docs/guide/configure-embedding-model/introduction.md +++ b/docs/guide/configure-embedding-model/introduction.md @@ -2,9 +2,9 @@ 嵌入模型(Embeddings) 可以将文本转换为向量，从而实现文本的语义表示。 -ChatHub 使用嵌入模型来将用户的输入，模型的输出等数据转换为向量。 +ChatLuna 使用嵌入模型来将用户的输入，模型的输出等数据转换为向量。 -目前，ChatHub 通过 嵌入模型 和 [向量数据库](../configure-vector-database/introduction.md) 为用户提供 [长期记忆](guide/session-related/long-term-memory) 功能。 +目前，ChatLuna 通过 嵌入模型 和 [向量数据库](../configure-vector-database/introduction.md) 为用户提供 [长期记忆](guide/session-related/long-term-memory) 功能。 ::: tip 在未来，我们可能还会基于嵌入模型和长期记忆库，实现基于资料的 QA 问答。 @@ -14,7 +14,7 @@ ChatHub 使用嵌入模型来将用户的输入，模型的输出等数据转换 因此，你可以直接使用这些插件来使用嵌入模型服务而无需安装嵌入模型服务插件。 -如果你不想使用模型适配器自带的嵌入模型服务，你也可以使用 ChatHub 提供的嵌入模型服务插件。 +如果你不想使用模型适配器自带的嵌入模型服务，你也可以使用 ChatLuna 提供的嵌入模型服务插件。 这里面提供了一些嵌入模型的适配器，你可以根据自己的需求选择合适的模型。 @@ -22,7 +22,7 @@ ChatHub 使用嵌入模型来将用户的输入，模型的输出等数据转换 ## 安装 -前往 Koishi 的插件市场，搜索 `chathub-embeddings-service`，并安装。 +前往 Koishi 的插件市场，搜索 `chatluna-embeddings-service`，并安装。 此插件还需要配置后才能使用，你可以在左侧的导航栏中选择你感兴趣的嵌入模型平台，然后按照其介绍进行配置。 diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index b327b271..41c635b5 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -1,10 +1,10 @@ # 快速上手 -本节，我们将指导你如何安装与配置 ChatHub，让你能快速的和模型进行对话。 +本节，我们将指导你如何安装与配置 ChatLuna，让你能快速的和模型进行对话。 ## 安装 Koishi -在使用 ChatHub 之前，你需要确保 [Node.js](https://nodejs.org/en) 版本在 v18 以上。 +在使用 ChatLuna 之前，你需要确保 [Node.js](https://nodejs.org/en) 版本在 v18 以上。 你可以使用 `node -v` 命令检查 Node.js 版本。 @@ -22,11 +22,11 @@ ## 安装前置依赖插件 -安装 ChatHub 的必要前置依赖插件，这些插件为 ChatHub 提供了基础的服务。 +安装 ChatLuna 的必要前置依赖插件，这些插件为 ChatLuna 提供了基础的服务。 ### 数据库插件 -ChatHub 需要 `database` 服务，用于存储会话信息等持久化数据。 +ChatLuna 需要 `database` 服务，用于存储会话信息等持久化数据。 我们推荐使用 `database-sqlite`，它自带在大部分 Koishi 环境里，轻量且开箱即用。 @@ -34,7 +34,7 @@ ChatHub 需要 `database` 服务，用于存储会话信息等持久化数据。 ### 缓存插件 -ChatHub 还需要 `cache` 服务，用于存储某些临时配置。 +ChatLuna 还需要 `cache` 服务，用于存储某些临时配置。 我们推荐使用 `cache-database`，它几乎不需要配置。 @@ -44,16 +44,16 @@ ChatHub 还需要 `cache` 服务，用于存储某些临时配置。 - `censor` 服务插件：用于回复内容过滤。注意，有的插件不审核文本信息，请注意识别。 - `vits` 服务插件：用于渲染模型回复，生成语音。 -## 安装 ChatHub 主插件 +## 安装 ChatLuna 主插件 -搜索并安装 `@dingyi222666/chathub` 插件，这是 ChatHub 的主插件。 +搜索并安装 `@dingyi222666/chatLuna` 插件，这是 ChatLuna 的主插件。 ::: warning 注意 主插件本身不包含任何平台适配，后面还需要安装平台适配插件。 ::: ## 安装模型适配器 -安装你需要平台的模型适配器。在插件市场输入 chathub + adapter 搜索。然后选择你需要的适配器安装。 +安装你需要平台的模型适配器。在插件市场输入 ChatLuna + adapter 搜索。然后选择你需要的适配器安装。 ![image](../public//images/plugin_market_pic1.png) @@ -78,10 +78,10 @@ ChatHub 还需要 `cache` 服务，用于存储某些临时配置。 填写完后右上角保存配置，启用插件即可。 ::: warning 注意 -如果你在国内环境使用，需要设置代理，请在`chathub`主插件的设置里设置代理(请求设置 -> [`isProxy`](/guide/useful-configurations#代理设置)，请求设置 -> [`proxyAddress`](/guide/useful-configurations#代理设置))。 +如果你在国内环境使用，需要设置代理，请在`ChatLuna`主插件的设置里设置代理(请求设置 -> [`isProxy`](/guide/useful-configurations#代理设置)，请求设置 -> [`proxyAddress`](/guide/useful-configurations#代理设置))。 ::: -可以使用 [`chathub.model.list`](/guide/useful-commands#模型列表)查看已启用的平台。 +可以使用 [`chatLuna.model.list`](/guide/useful-commands#模型列表)查看已启用的平台。 ## 设置模版房间配置 @@ -92,13 +92,13 @@ ChatHub 还需要 `cache` 服务，用于存储某些临时配置。 设置好模型，聊天模式和预设，右上角保存后即完成配置。 ::: tip 提示 -对于初次使用 ChatHub 的新手，我们推荐直接使用模型克隆房间。当你对 ChatHub 有深入了解后，才推荐使用自定义的房间系统。 +对于初次使用 ChatLuna 的新手，我们推荐直接使用模型克隆房间。当你对 ChatLuna 有深入了解后，才推荐使用自定义的房间系统。 ::: ## 开始聊天 -最后使用 [`chathub.chat.text`](/guide/useful-commands#模型对话) 命令开始和模型聊天。 +最后使用 [`chatLuna.chat.text`](/guide/useful-commands#模型对话) 命令开始和模型聊天。 -通过以上步骤，你已经配置好了 ChatHub，并且可以和模型聊天了。 +通过以上步骤，你已经配置好了 ChatLuna，并且可以和模型聊天了。 接下来你可以在下面的章节学习到更多的配置和使用方法。 diff --git a/docs/guide/introduction.md b/docs/guide/introduction.md index 13445072..33a473ef 100644 --- a/docs/guide/introduction.md +++ b/docs/guide/introduction.md @@ -1,6 +1,6 @@ # 插件介绍 -[ChatLuna](https://github.com/ChatLunaLab/chathub) 是一款基于 [LangChain](https://github.com/hwchase17/langchainjs) 的语言模型聊天服务插件，运行在 [Koishi](https://koishi.chat/zh-CN/) 上。 +[ChatLuna](https://github.com/ChatLunaLab/chatluna) 是一款基于 [LangChain](https://github.com/hwchase17/langchainjs) 的语言模型聊天服务插件，运行在 [Koishi](https://koishi.chat/zh-CN/) 上。 它可以让用户与目前流行的语言模型或平台进行聊天互动，如 OpenAI（API）、New Bing、ChatGLM 等。项目底层和语言模型交互的模块基于 LangChain，其他 Koishi 插件开发者也可以使用此项目提供的 [LangChain Model](https://js.langchain.com/docs/modules/models/chat/) 和大语言模型进行交互。 diff --git a/docs/guide/preset-system/share-preset.md b/docs/guide/preset-system/share-preset.md index 9363f92b..b98d0c61 100644 --- a/docs/guide/preset-system/share-preset.md +++ b/docs/guide/preset-system/share-preset.md @@ -1,10 +1,10 @@ # 分享预设 -我们欢迎所有人分享自己的预设到 ChatHub 的预设仓库。 +我们欢迎所有人分享自己的预设到 ChatLuna的预设仓库。 如果你有预设想要分享，你可以按照以下步骤操作： -1. Fork [awesome-chathub-presets](https://github.com/ChatHubLab/awesome-chathub-presets) 项目到你自己的 GitHub 账号下。 +1. Fork [awesome-chatluna-presets](https://github.com/ChatLunaLab/awesome-chatluna-presets) 项目到你自己的 GitHub 账号下。 2. 把你编写好的预设文件放入 presets 文件夹中，并且确保文件和已有的预设文件（包括关键词，文件名）不冲突。 3. 提交 Pull Request，在描述中简要介绍你的预设。 4. 等待我们审核并合并你的 Pull Request。 diff --git a/docs/guide/preset-system/switch-preset.md b/docs/guide/preset-system/switch-preset.md index 7bd03b9c..0c731d77 100644 --- a/docs/guide/preset-system/switch-preset.md +++ b/docs/guide/preset-system/switch-preset.md @@ -4,7 +4,7 @@ ## 如何使用预设? -1. 前往 [presets](https://github.com/ChatHubLab/awesome-chathub-presets/tree/main/presets) 文件夹，浏览并下载你喜欢的预设文件。 +1. 前往 [presets](https://github.com/ChatLunaLab/awesome-chatluna-presets/tree/main/presets) 文件夹，浏览并下载你喜欢的预设文件。 2. 找到你的 Koishi 插件的安装目录，然后将下载的预设文件放入 `data/chathub/presets` 文件夹中。 -3. 使用 [`chathub.preset.list`](#预设列表) 命令，查看你已经添加的预设。 -4. 使用 [`chathub.room.set -p `](#设置预设) 命令，对当前你所在的房间切换为你想要使用的预设。 +3. 使用 [`chatluna.preset.list`](#预设列表) 命令，查看你已经添加的预设。 +4. 使用 [`chatluna.room.set -p `](#设置预设) 命令，对当前你所在的房间切换为你想要使用的预设。 diff --git a/docs/guide/preset-system/write-preset.md b/docs/guide/preset-system/write-preset.md index c403d421..6cf98693 100644 --- a/docs/guide/preset-system/write-preset.md +++ b/docs/guide/preset-system/write-preset.md @@ -1,10 +1,10 @@ # 编写预设 -谁不想拥有一只自己的赛博猫娘呢？使用预设系统可以轻松的让模型进行角色扮演，认为自己是猫娘，甚至是更多角色。本章我们将教大家如何编写预设，并应用到 ChatHub 上。 +谁不想拥有一只自己的赛博猫娘呢？使用预设系统可以轻松的让模型进行角色扮演，认为自己是猫娘，甚至是更多角色。本章我们将教大家如何编写预设，并应用到 ChatLuna 上。 ## 基础格式 -让我们先阅读一下 ChatHub 提供的两个预设文件 +让我们先阅读一下 ChatLuna 提供的两个预设文件 ::: code-group ```yml [chatgpt.yml] @@ -47,7 +47,7 @@ format_user_prompt: "用户{sender}说: {prompt}" ``` ::: -阅读上面的示例文件，相信你已经对 ChatHub 的预设文件有了基础的认识，接下来让我们更进一步，细致的讲解每个属性的用处吧。 +阅读上面的示例文件，相信你已经对 ChatLuna 的预设文件有了基础的认识，接下来让我们更进一步，细致的讲解每个属性的用处吧。 ### 关键词 @@ -55,7 +55,7 @@ format_user_prompt: "用户{sender}说: {prompt}" 一个预设文件可以含有多个关键词，这意味着关键词实际上是一个数组。 -预设文件中的关键词可以被 ChatHub 识别，当用户使用命令创建或修改房间时，输入的关键词就会让 ChatHub 去寻找对应的预设文件。 +预设文件中的关键词可以被 ChatLuna 识别，当用户使用命令创建或修改房间时，输入的关键词就会让 ChatLuna 去寻找对应的预设文件。 也就是说，关键词属于预设文件的唯一标识符。 @@ -96,13 +96,13 @@ prompts 属性内是一个数组，数组内含有 `role`, `content` 属性组 ### 变量占位符 -变量占位符是由 ChatHub 提供的一些固定量，在发送时会被替换为某些值。语法如下: +变量占位符是由 ChatLuna 提供的一些固定量，在发送时会被替换为某些值。语法如下: ```txt text{variable_name} ``` -目前 ChatHub 提供了以下变量供使用（后续可能还会增加其他变量）: +目前 ChatLuna 提供了以下变量供使用（后续可能还会增加其他变量）: - `date`: 当前日期，遵循标准 UTC 格式。 - `sender`: 发送者 (只在 format_user_prompt 里有效）。 @@ -143,7 +143,7 @@ prompts: content: 杂鱼大叔这么快就想人家了嘛？ ``` -把写好的文件复制到 `你的 koishi 目录 + data/chathub/preset` 文件夹，然后调用 `chathub.preset.list`。此时如果正常，则会在输出的列表中找到雌小鬼这个预设。后续自己使用 `chathub.room.set -p ` 设置即可。 +把写好的文件复制到 `你的 koishi 目录 + data/chathub/preset` 文件夹，然后调用 `chatluna.preset.list`。此时如果正常，则会在输出的列表中找到雌小鬼这个预设。后续自己使用 `chatluna.room.set -p ` 设置即可。 ## 要点 diff --git a/docs/guide/useful-configurations.md b/docs/guide/useful-configurations.md index 3723e339..ce4b5134 100644 --- a/docs/guide/useful-configurations.md +++ b/docs/guide/useful-configurations.md @@ -1,6 +1,6 @@ # 配置项 -本节介绍了主插件(`@dingyi222666/chathub`)可用的配置项。对于其他插件或适配器的配置项，请参考对应的文档。 +本节介绍了主插件(`@dingyi222666/chatLuna`)可用的配置项。对于其他插件或适配器的配置项，请参考对应的文档。 ## Bot 配置 @@ -25,7 +25,7 @@ Bot 的昵称，该昵称可用于下方的[关键词唤醒](#isnickname)对话 - 类型：`boolean` - 默认值：`true` -是否能在私聊中调用 ChatHub，开启后将可以在私聊中通过命令调用 ChatHub。 +是否能在私聊中调用 ChatLuna，开启后将可以在私聊中通过命令调用 ChatLuna。 ### allowAtReply diff --git a/docs/index.md b/docs/index.md index c22571b2..5cb07f37 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,7 @@ title: ChatLuna Doc editLink: true hero: - name: ChatLuna ChatHub + name: ChatLuna text: 使用教程 & 开发指南 tagline: 提供多平台语言模型聊天服务，可选多种输出格式，另配高度可扩展插件系统 actions: