From fb428ffc1990cb80dfc9f80a4dae66a942fb58f3 Mon Sep 17 00:00:00 2001 From: Asankilp Date: Sun, 29 Dec 2024 15:01:10 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E5=AE=89=E8=A3=85=E6=96=87?= =?UTF-8?q?=E6=A1=A3=EF=BC=8C=E4=BF=AE=E6=AD=A3=E9=93=BE=E6=8E=A5=EF=BC=8C?= =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E5=B0=8F=E6=A3=89=E5=B7=A5=E5=85=B7=E7=9A=84?= =?UTF-8?q?=E7=9B=B8=E5=85=B3=E4=BF=A1=E6=81=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config/zh.ts | 2 +- docs/zh/dev/extension.md | 10 ++++++-- docs/zh/index.md | 2 +- .../start/{install-old.md => install-new.md} | 24 +++++++++++++++---- docs/zh/start/install.md | 24 ++++--------------- 5 files changed, 34 insertions(+), 28 deletions(-) rename docs/zh/start/{install-old.md => install-new.md} (85%) diff --git a/docs/.vitepress/config/zh.ts b/docs/.vitepress/config/zh.ts index a5269c29..a3196706 100644 --- a/docs/.vitepress/config/zh.ts +++ b/docs/.vitepress/config/zh.ts @@ -12,7 +12,7 @@ export const zh = defineConfig({ }, nav: [ {text: '家', link: '/'}, - {text: '使用', link: '/start/install-old'}, + {text: '使用', link: '/start/install'}, {text: '开发', link: '/dev/extension'}, ], editLink: ThemeConfig.getEditLink('编辑此页面'), diff --git a/docs/zh/dev/extension.md b/docs/zh/dev/extension.md index 8499d498..58d59cb5 100755 --- a/docs/zh/dev/extension.md +++ b/docs/zh/dev/extension.md @@ -9,7 +9,9 @@ order: 2 扩展分为两类，一类为插件，一类为工具。 - 插件 -- 工具(由于开发的不便利性，已经停止维护，未来可能会放弃支持，如有需求请看README中的内容，我们不推荐再使用此功能) +- 工具(由于开发的不便利性，已经停止维护，未来可能会放弃支持，如有需求请看README中的内容，我们不推荐再使用此功能) + +**`v1.0.0`之前的版本不支持小棉插件。** ## 插件 @@ -57,7 +59,11 @@ async def weather(location: str) -> str: ## 函数调用参数 -`on_function_call`装饰器用于标记一个函数为function call，`description`参数用于描述这个函数的作用，`params`方法用于定义函数的参数，`String`、`Integer`等是OpenAI API接受的参数的类型，`description`是参数的描述。这些都是给AI看的，AI会根据这些信息来调用函数。 +`on_function_call`装饰器用于标记一个函数为function call，`description`参数用于描述这个函数的作用，`params`方法用于定义函数的参数，`String`、`Integer`等是OpenAI API接受的参数的类型，`description`是参数的描述。这些都是给AI看的，AI会根据这些信息来调用函数。 + +:::warning +参数名不得为`placeholder`。此参数名是Marsho内部保留的用于保证兼容性的占位参数。 +::: ```python @on_function_call(description="可以用于算命").params( diff --git a/docs/zh/index.md b/docs/zh/index.md index 8c9e6ee2..9d7d1d95 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -9,7 +9,7 @@ hero: actions: - theme: brand text: 开始使用 - link: /start/install-old/ + link: /start/install/ - theme: alt text: 开发及扩展 link: /dev/extension/ diff --git a/docs/zh/start/install-old.md b/docs/zh/start/install-new.md similarity index 85% rename from docs/zh/start/install-old.md rename to docs/zh/start/install-new.md index 18ad38b5..ddd892f5 100644 --- a/docs/zh/start/install-old.md +++ b/docs/zh/start/install-new.md @@ -60,8 +60,13 @@ title: 安装 当 nonebot 连接到支持的 OneBot v11 实现端时，可以接收头像双击戳一戳消息并进行响应。详见`MARSHOAI_POKE_SUFFIX`配置项。 -## 🛠️ 小棉工具 -小棉工具(MarshoTools)是`v0.5.0`版本的新增功能，支持加载外部函数库来为 Marsho 提供 Function Call 功能。[使用文档] +## 🛠️ ~~小棉工具~~（已弃用） + +小棉工具(MarshoTools)是`v0.5.0`版本的新增功能，支持加载外部函数库来为 Marsho 提供 Function Call 功能。 + +## 🧩 小棉插件 + +小棉插件是`v1.0.0`的新增功能，替代旧的小棉工具功能。[使用文档](https://marsho.liteyuki.icu/dev/extension) ## 👍 夸赞名单 @@ -95,6 +100,7 @@ title: 安装 | 配置项 | 类型 | 默认值 | 说明 | | ------------------------ | ------ | ------- | ---------------- | | MARSHOAI_USE_YAML_CONFIG | `bool` | `false` | 是否使用 YAML 配置文件格式 | +| MARSHOAI_DEVMODE | `bool` | `false` | 是否启用开发者模式 | #### Marsho 使用方式 @@ -113,6 +119,7 @@ title: 安装 | MARSHOAI_DEFAULT_MODEL | `str` | `gpt-4o-mini` | Marsho 默认调用的模型 | | MARSHOAI_PROMPT | `str` | 猫娘 Marsho 人设提示词 | Marsho 的基本系统提示词 **※部分模型(o1等)不支持系统提示词。** | | MARSHOAI_ADDITIONAL_PROMPT | `str` | | Marsho 的扩展系统提示词 | +| MARSHOAI_ENFORCE_NICKNAME | `bool` | `true` | 是否强制用户设置昵称 | | MARSHOAI_POKE_SUFFIX | `str` | `揉了揉你的猫耳` | 对 Marsho 所连接的 OneBot 用户进行双击戳一戳时，构建的聊天内容。此配置项为空字符串时，戳一戳响应功能会被禁用。例如，默认值构建的聊天内容将为`*[昵称]揉了揉你的猫耳。` | | MARSHOAI_AZURE_ENDPOINT | `str` | `https://models.inference.ai.azure.com` | OpenAI 标准格式 API 端点 | | MARSHOAI_TEMPERATURE | `float` | `null` | 推理生成多样性（温度）参数 | @@ -127,9 +134,18 @@ title: 安装 | MARSHOAI_ENABLE_SUPPORT_IMAGE_TIP | `bool` | `true` | 启用后用户发送带图请求时若模型不支持图片，则提示用户 | | MARSHOAI_ENABLE_NICKNAME_TIP | `bool` | `true` | 启用后用户未设置昵称时提示用户设置 | | MARSHOAI_ENABLE_PRAISES | `bool` | `true` | 是否启用夸赞名单功能 | -| MARSHOAI_ENABLE_TOOLS | `bool` | `true` | 是否启用小棉工具 | +| MARSHOAI_ENABLE_TOOLS | `bool` | `false` | 是否启用小棉工具 | +| MARSHOAI_ENABLE_PLUGINS | `bool` | `true` | 是否启用小棉插件 | +| MARSHOAI_PLUGINS | `list[str]` | `[]` | 要从`sys.path`加载的插件的名称，例如从pypi安装的包 | +| MARSHOAI_PLUGIN_DIRS | `list[str]` | `[]` | 插件目录路径列表 | | MARSHOAI_LOAD_BUILTIN_TOOLS | `bool` | `true` | 是否加载内置工具包 | | MARSHOAI_TOOLSET_DIR | `list` | `[]` | 外部工具集路径列表 | | MARSHOAI_DISABLED_TOOLKITS | `list` | `[]` | 禁用的工具包包名列表 | | MARSHOAI_ENABLE_RICHTEXT_PARSE | `bool` | `true` | 是否启用自动解析消息（若包含图片链接则发送图片、若包含LaTeX公式则发送公式图） | -| MARSHOAI_SINGLE_LATEX_PARSE | `bool` | `false` | 单行公式是否渲染（当消息富文本解析启用时可用）（如果单行也渲……只能说不好看） | \ No newline at end of file +| MARSHOAI_SINGLE_LATEX_PARSE | `bool` | `false` | 单行公式是否渲染（当消息富文本解析启用时可用）（如果单行也渲……只能说不好看） | + +#### 开发及调试选项 + +| 配置项 | 类型 | 默认值 | 说明 | +| ------------------------ | ------ | ------- | ---------------- | +| MARSHOAI_DEVMODE | `bool` | `false` | 是否启用开发者模式 | diff --git a/docs/zh/start/install.md b/docs/zh/start/install.md index ddd892f5..18ad38b5 100644 --- a/docs/zh/start/install.md +++ b/docs/zh/start/install.md @@ -60,13 +60,8 @@ title: 安装 当 nonebot 连接到支持的 OneBot v11 实现端时，可以接收头像双击戳一戳消息并进行响应。详见`MARSHOAI_POKE_SUFFIX`配置项。 -## 🛠️ ~~小棉工具~~（已弃用） - -小棉工具(MarshoTools)是`v0.5.0`版本的新增功能，支持加载外部函数库来为 Marsho 提供 Function Call 功能。 - -## 🧩 小棉插件 - -小棉插件是`v1.0.0`的新增功能，替代旧的小棉工具功能。[使用文档](https://marsho.liteyuki.icu/dev/extension) +## 🛠️ 小棉工具 +小棉工具(MarshoTools)是`v0.5.0`版本的新增功能，支持加载外部函数库来为 Marsho 提供 Function Call 功能。[使用文档] ## 👍 夸赞名单 @@ -100,7 +95,6 @@ title: 安装 | 配置项 | 类型 | 默认值 | 说明 | | ------------------------ | ------ | ------- | ---------------- | | MARSHOAI_USE_YAML_CONFIG | `bool` | `false` | 是否使用 YAML 配置文件格式 | -| MARSHOAI_DEVMODE | `bool` | `false` | 是否启用开发者模式 | #### Marsho 使用方式 @@ -119,7 +113,6 @@ title: 安装 | MARSHOAI_DEFAULT_MODEL | `str` | `gpt-4o-mini` | Marsho 默认调用的模型 | | MARSHOAI_PROMPT | `str` | 猫娘 Marsho 人设提示词 | Marsho 的基本系统提示词 **※部分模型(o1等)不支持系统提示词。** | | MARSHOAI_ADDITIONAL_PROMPT | `str` | | Marsho 的扩展系统提示词 | -| MARSHOAI_ENFORCE_NICKNAME | `bool` | `true` | 是否强制用户设置昵称 | | MARSHOAI_POKE_SUFFIX | `str` | `揉了揉你的猫耳` | 对 Marsho 所连接的 OneBot 用户进行双击戳一戳时，构建的聊天内容。此配置项为空字符串时，戳一戳响应功能会被禁用。例如，默认值构建的聊天内容将为`*[昵称]揉了揉你的猫耳。` | | MARSHOAI_AZURE_ENDPOINT | `str` | `https://models.inference.ai.azure.com` | OpenAI 标准格式 API 端点 | | MARSHOAI_TEMPERATURE | `float` | `null` | 推理生成多样性（温度）参数 | @@ -134,18 +127,9 @@ title: 安装 | MARSHOAI_ENABLE_SUPPORT_IMAGE_TIP | `bool` | `true` | 启用后用户发送带图请求时若模型不支持图片，则提示用户 | | MARSHOAI_ENABLE_NICKNAME_TIP | `bool` | `true` | 启用后用户未设置昵称时提示用户设置 | | MARSHOAI_ENABLE_PRAISES | `bool` | `true` | 是否启用夸赞名单功能 | -| MARSHOAI_ENABLE_TOOLS | `bool` | `false` | 是否启用小棉工具 | -| MARSHOAI_ENABLE_PLUGINS | `bool` | `true` | 是否启用小棉插件 | -| MARSHOAI_PLUGINS | `list[str]` | `[]` | 要从`sys.path`加载的插件的名称，例如从pypi安装的包 | -| MARSHOAI_PLUGIN_DIRS | `list[str]` | `[]` | 插件目录路径列表 | +| MARSHOAI_ENABLE_TOOLS | `bool` | `true` | 是否启用小棉工具 | | MARSHOAI_LOAD_BUILTIN_TOOLS | `bool` | `true` | 是否加载内置工具包 | | MARSHOAI_TOOLSET_DIR | `list` | `[]` | 外部工具集路径列表 | | MARSHOAI_DISABLED_TOOLKITS | `list` | `[]` | 禁用的工具包包名列表 | | MARSHOAI_ENABLE_RICHTEXT_PARSE | `bool` | `true` | 是否启用自动解析消息（若包含图片链接则发送图片、若包含LaTeX公式则发送公式图） | -| MARSHOAI_SINGLE_LATEX_PARSE | `bool` | `false` | 单行公式是否渲染（当消息富文本解析启用时可用）（如果单行也渲……只能说不好看） | - -#### 开发及调试选项 - -| 配置项 | 类型 | 默认值 | 说明 | -| ------------------------ | ------ | ------- | ---------------- | -| MARSHOAI_DEVMODE | `bool` | `false` | 是否启用开发者模式 | +| MARSHOAI_SINGLE_LATEX_PARSE | `bool` | `false` | 单行公式是否渲染（当消息富文本解析启用时可用）（如果单行也渲……只能说不好看） | \ No newline at end of file