2025-01-26 11:07:43 +00:00
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="zh-Hans" dir="ltr">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
<title>安装 | 小棉智能</title>
|
|
|
|
|
<meta name="description" content="可爱,智能且易扩展">
|
|
|
|
|
<meta name="generator" content="VitePress v1.6.3">
|
|
|
|
|
<link rel="preload stylesheet" href="/assets/style.DvoidLlL.css" as="style">
|
|
|
|
|
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
|
|
|
|
|
|
|
|
|
<script type="module" src="/assets/app.B_RH-Usd.js"></script>
|
|
|
|
|
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
|
|
|
|
<link rel="modulepreload" href="/assets/chunks/theme.NEjmdO-F.js">
|
|
|
|
|
<link rel="modulepreload" href="/assets/chunks/framework.BzDBnRMZ.js">
|
|
|
|
|
<link rel="modulepreload" href="/assets/start_install-old.md.F642ZtXe.lean.js">
|
|
|
|
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
|
|
|
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
|
|
|
|
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div id="app"><div class="Layout" data-v-46cada41><!--[--><!--]--><!--[--><span tabindex="-1" data-v-82af304d></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-82af304d>Skip to content</a><!--]--><!----><header class="VPNav" data-v-46cada41 data-v-0ec1cc98><div class="VPNavBar" data-v-0ec1cc98 data-v-97e37718><div class="wrapper" data-v-97e37718><div class="container" data-v-97e37718><div class="title" data-v-97e37718><div class="VPNavBarTitle has-sidebar" data-v-97e37718 data-v-9620ba61><a class="title" href="/" data-v-9620ba61><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-ce14eec4><!--]--><!--[--><img class="VPImage light logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-ce14eec4><!--]--><!--]--><!--]--><span data-v-9620ba61>小棉智能</span><!--[--><!--]--></a></div></div><div class="content" data-v-97e37718><div class="content-body" data-v-97e37718><!--[--><!--]--><div class="VPNavBarSearch search" data-v-97e37718><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-97e37718 data-v-fd0d02da><span id="main-nav-aria-label" class="visually-hidden" data-v-fd0d02da> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-fd0d02da data-v-c7cdc412><!--[--><span data-v-c7cdc412>家</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/start/use" tabindex="0" data-v-fd0d02da data-v-c7cdc412><!--[--><span data-v-c7cdc412>使用</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/dev/extension" tabindex="0" data-v-fd0d02da data-v-c7cdc412><!--[--><span data-v-c7cdc412>开发</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-97e37718 data-v-da60b316 data-v-3174d294><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="语言" data-v-3174d294><span class="text" data-v-3174d294><span class="vpi-languages option-icon" data-v-3174d294></span><!----><span class="vpi-chevron-down text-icon" data-v-3174d294></span></span></button><div class="menu" data-v-3174d294><div class="VPMenu" data-v-3174d294 data-v-90ca5f1b><!----><!--[--><!--[--><div class="items" data-v-da60b316><p class="title" data-v-da60b316>简体中文</p><!--[--><div class="VPMenuLink" data-v-da60b316 data-v-5a3b110a><a class="VPLink link" href="/en/start/install-old" data-v-5a3b110a><!--[--><span data-v-5a3b110a>English</span><!--]--></a></div><div class="VPMenuLink" data-v-da60b316 data-v-5a3b110a><a class="VPLink link" href="/ja/start/install-old" data-v-5a3b110a><!--[--><span data-v-5a3b110a>日本語</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-97e37718 data-v-b569c26a><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-b569c26a data-v-a8d11977 data-v-d4fb1d40><span class="check" data-v-d4fb1d40><span class="icon" data-v-d4fb1d40><!--[--><span class="vpi-sun sun" data-v-a8d11977></span><span class="vpi-moon moon" data-v-a8d11977></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-97e37718 data-v-25e71cd1 data-v-93344165><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai" aria-label="github" target="_blank" rel="noopener" data-v-93344165 data-v-b8870a62><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://git.liteyuki.icu/LiteyukiStudio/nonebot-plugin-marshoai" aria-label target="_blank" rel="noopener" data-v-93344165 data-v-b8870a62><svg t="1725391346807" class="icon" viewBox="0 0 1025 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5067" width="256" height="256"><path d="M1004.692673 466.396616l-447.094409-447.073929c-25.743103-25.763582-67.501405-25.763582-93.264987 0l-103.873521 103.873521 78.171378 78.171378c12.533635-6.00058 26.562294-9.35926
|
|
|
|
|
</code></pre></details><details><summary>使用包管理器安装</summary> 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令 <details><summary>pip</summary><pre><code>pip install nonebot-plugin-marshoai
|
|
|
|
|
</code></pre></details><details><summary>pdm</summary><pre><code>pdm add nonebot-plugin-marshoai
|
|
|
|
|
</code></pre></details><details><summary>poetry</summary><pre><code>poetry add nonebot-plugin-marshoai
|
|
|
|
|
</code></pre></details><details><summary>conda</summary><pre><code>conda install nonebot-plugin-marshoai
|
|
|
|
|
</code></pre></details><p>打开 nonebot2 项目根目录下的 <code>pyproject.toml</code> 文件, 在 <code>[tool.nonebot]</code> 部分追加写入</p><pre><code>plugins = ["nonebot_plugin_marshoai"]
|
|
|
|
|
</code></pre></details><h2 id="🤖-获取-token-github-models" tabindex="-1">🤖 获取 token(GitHub Models) <a class="header-anchor" href="#🤖-获取-token-github-models" aria-label="Permalink to "🤖 获取 token(GitHub Models)""></a></h2><ul><li>新建一个<a href="https://github.com/settings/tokens/new" target="_blank" rel="noreferrer">personal access token</a>,<strong>不需要给予任何权限</strong>。</li><li>将新建的 token 复制,添加到<code>.env</code>文件中的<code>marshoai_token</code>配置项中。</li></ul><h2 id="🎉-使用" tabindex="-1">🎉 使用 <a class="header-anchor" href="#🎉-使用" aria-label="Permalink to "🎉 使用""></a></h2><p>发送<code>marsho</code>指令可以获取使用说明(若在配置中自定义了指令前缀请使用自定义的指令前缀)。</p><h4 id="👉-戳一戳" tabindex="-1">👉 戳一戳 <a class="header-anchor" href="#👉-戳一戳" aria-label="Permalink to "👉 戳一戳""></a></h4><p>当 nonebot 连接到支持的 OneBot v11 实现端时,可以接收头像双击戳一戳消息并进行响应。详见<code>MARSHOAI_POKE_SUFFIX</code>配置项。</p><h2 id="🛠️-小棉工具" tabindex="-1">🛠️ 小棉工具 <a class="header-anchor" href="#🛠️-小棉工具" aria-label="Permalink to "🛠️ 小棉工具""></a></h2><p>小棉工具(MarshoTools)是<code>v0.5.0</code>版本的新增功能,支持加载外部函数库来为 Marsho 提供 Function Call 功能。[使用文档]</p><h2 id="👍-夸赞名单" tabindex="-1">👍 夸赞名单 <a class="header-anchor" href="#👍-夸赞名单" aria-label="Permalink to "👍 夸赞名单""></a></h2><p>夸赞名单存储于插件数据目录下的<code>praises.json</code>里(该目录路径会在 Bot 启动时输出到日志),当配置项为<code>true</code> 时发起一次聊天后自动生成,包含人物名字与人物优点两个基本数据。 存储于其中的人物会被 Marsho “认识”和“喜欢”。 其结构类似于:</p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "like"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "name"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"Asankilp"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "advantages"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"赋予了Marsho猫娘人格,使用vim与vscode为Marsho写了许多代码,使Marsho更加可爱"</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "name"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"神羽(snowykami)"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "advantages"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"人脉很广,经常找小伙伴们开银趴,很会写后端代码"</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#B31D28;--shiki-light-font-style:italic;--shiki-dark:#FDAEB7;--shiki-dark-font-style:italic;"> ...</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ]</span></span>
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h2 id="⚙️-可配置项" tabindex="-1">⚙️ 可配置项 <a class="header-anchor" href="#⚙️-可配置项" aria-label="Permalink to "⚙️ 可配置项""></a></h2><p>在 nonebot2 项目的<code>.env</code>文件中添加下表中的配置</p><h4 id="插件行为" tabindex="-1">插件行为 <a class="header-anchor" href="#插件行为" aria-label="Permalink to "插件行为""></a></h4><table tabindex="0"><thead><tr><th>配置项</th><th>类型</th><th>默认值</th><th>说明</th></tr></thead><tbody><tr><td>MARSHOAI_USE_YAML_CONFIG</td><td><code>bool</code></td><td><code>false</code></td><td>是否使用 YAML 配置文件格式</td></tr></tbody></table><h4 id="marsho-使用方式" tabindex="-1">Marsho 使用方式 <a class="header-anchor" href="#marsho-使用方式" aria-label="Permalink to "Marsho 使用方式""></a></h4><table tabindex="0"><thead><tr><th>配置项</th><th>类型</th><th>默认值</th><th>说明</th></tr></thead><tbody><tr><td>MARSHOAI_DEFAULT_NAME</td><td><code>str</code></td><td><code>marsho</code></td><td>调用 Marsho 默认的命令前缀</td></tr><tr><td>MARSHOAI_ALIASES</td><td><code>set[str]</code></td><td><code>set{"小棉"}</code></td><td>调用 Marsho 的命令别名</td></tr><tr><td>MARSHOAI_AT</td><td><code>bool</code></td><td><code>false</code></td><td>决定是否使用at触发</td></tr><tr><td>MARSHOAI_MAIN_COLOUR</td><td><code>str</code></td><td><code>FFAAAA</code></td><td>主题色,部分工具和功能可用</td></tr></tbody></table><h4 id="ai-调用" tabindex="-1">AI 调用 <a class="header-anchor" href="#ai-调用" aria-label="Permalink to "AI 调用""></a></h4><table tabindex="0"><thead><tr><th>配置项</th><th>类型</th><th>默认值</th><th>说明</th></tr></thead><tbody><tr><td>MARSHOAI_TOKEN</td><td><code>str</code></td><td></td><td>调用 AI API 所需的 token</td></tr><tr><td>MARSHOAI_DEFAULT_MODEL</td><td><code>str</code></td><td><code>gpt-4o-mini</code></td><td>Marsho 默认调用的模型</td></tr><tr><td>MARSHOAI_PROMPT</td><td><code>str</code></td><td>猫娘 Marsho 人设提示词</td><td>Marsho 的基本系统提示词 <strong>※部分模型(o1等)不支持系统提示词。</strong></td></tr><tr><td>MARSHOAI_ADDITIONAL_PROMPT</td><td><code>str</code></td><td></td><td>Marsho 的扩展系统提示词</td></tr><tr><td>MARSHOAI_POKE_SUFFIX</td><td><code>str</code></td><td><code>揉了揉你的猫耳</code></td><td>对 Marsho 所连接的 OneBot 用户进行双击戳一戳时,构建的聊天内容。此配置项为空字符串时,戳一戳响应功能会被禁用。例如,默认值构建的聊天内容将为<code>*[昵称]揉了揉你的猫耳。</code></td></tr><tr><td>MARSHOAI_AZURE_ENDPOINT</td><td><code>str</code></td><td><code>https://models.inference.ai.azure.com</code></td><td>OpenAI 标准格式 API 端点</td></tr><tr><td>MARSHOAI_TEMPERATURE</td><td><code>float</code></td><td><code>null</code></td><td>推理生成多样性(温度)参数</td></tr><tr><td>MARSHOAI_TOP_P</td><td><code>float</code></td><td><code>null</code></td><td>推理核采样参数</td></tr><tr><td>MARSHOAI_MAX_TOKENS</td><td><code>int</code></td><td><code>null</code></td><td>最大生成 token 数</td></tr><tr><td>MARSHOAI_ADDITIONAL_IMAGE_MODELS</td><td><code>list</code></td><td><code>[]</code></td><td>额外添加的支持图片的模型列表,例如<code>hunyuan-vision</code></td></tr></tbody></table><h4 id="功能开关" tabindex="-1">功能开关 <a class="header-anchor" href="#功能开关" aria-label="Permalink to "功能开关""></a></h4><table tabindex="0"><thead><tr><th>配置项</th><th>类型</th><th>默认值</th><th>说明</th></tr></thead><tbody><tr><td>MARSHOAI_ENABLE_SUPPORT_IMAGE_TIP</td><td><code>bool</code></td><td><code>true</code></td><td>启用后用户发送带图请求时若模型不支持图片,则提示用户</td></tr><tr><td>MARSHOAI_ENABLE_NICKNAME_TIP</t
|
2025-01-27 10:51:19 +00:00
|
|
|
|
<script>window.__VP_HASH_MAP__=JSON.parse("{\"dev_api_azure.md\":\"By3DQZ1H\",\"dev_api_azure_onebot.md\":\"BSzQi5NB\",\"dev_api_config.md\":\"CyF6aaww\",\"dev_api_constants.md\":\"CeyS-dgb\",\"dev_api_deal_latex.md\":\"D5Q0mV0c\",\"dev_api_dev.md\":\"CR8NfY8m\",\"dev_api_hooks.md\":\"DpJrlEUX\",\"dev_api_hunyuan.md\":\"DTtTdru3\",\"dev_api_index.md\":\"LG7oRavz\",\"dev_api_instances.md\":\"VkCkhorR\",\"dev_api_marsho.md\":\"DEHEMRnq\",\"dev_api_marsho_onebot.md\":\"BaELa_5s\",\"dev_api_metadata.md\":\"BvJb0wDC\",\"dev_api_models.md\":\"CzLGyN0e\",\"dev_api_observer.md\":\"CKxQ8rNr\",\"dev_api_plugin_func_call_caller.md\":\"CzrTsykV\",\"dev_api_plugin_func_call_index.md\":\"DSbV-DHP\",\"dev_api_plugin_func_call_models.md\":\"CYOWq9i6\",\"dev_api_plugin_func_call_params.md\":\"DIr0Wfuh\",\"dev_api_plugin_func_call_utils.md\":\"CBpuIEsL\",\"dev_api_plugin_index.md\":\"BpLPZBto\",\"dev_api_plugin_load.md\":\"Z1_AJpA-\",\"dev_api_plugin_models.md\":\"XO9ZgJTV\",\"dev_api_plugin_register.md\":\"wxtxwL1q\",\"dev_api_plugin_typing.md\":\"B_OdqvYr\",\"dev_api_plugin_utils.md\":\"CKZ8uSFc\",\"dev_api_plugins_builtin_tools_chat.md\":\"CX5fWmLQ\",\"dev_api_plugins_builtin_tools_file_io.md\":\"B4WB3kMa\",\"dev_api_plugins_builtin_tools_index.md\":\"CdVyaR56\",\"dev_api_plugins_builtin_tools_liteyuki.md\":\"C2jQUuMC\",\"dev_api_plugins_builtin_tools_manager.md\":\"CSx6-DqR\",\"dev_api_plugins_builtin_tools_network.md\":\"qwTduvJA\",\"dev_api_plugins_builtin_tools_utils.md\":\"BQ_zIszy\",\"dev_api_plugins_marshoai_bangumi_index.md\":\"DI0wDzaI\",\"dev_api_plugins_marshoai_basic_index.md\":\"CdMZUtoa\",\"dev_api_plugins_test_marshoai_basic_index.md\":\"ChCsmGGV\",\"dev_api_plugins_test_marshoai_memory_command.md\":\"CeJIbyf1\",\"dev_api_plugins_test_marshoai_memory_config.md\":\"CtBtnl-b\",\"dev_api_plugins_test_marshoai_memory_index.md\":\"wgRBaFEj\",\"dev_api_plugins_test_random_number_generator.md\":\"CP2ZOHnt\",\"dev_api_plugins_test_snowykami_testplugin_index.md\":\"DGUrAa-4\",\"dev_api_plugins_test_weather_demo.md\":\"BhjRtDMw\",\"dev_api_plugins_twisuki_megakits_index.md\":\"Dhj0Q_rd\",\"dev_api_plugins_twisuki_megakits_mk_morse_code.md\":\"BPtKSrvY\",\"dev_api_plugins_twisuki_megakits_mk_nya_code.md\":\"BDLuQWQj\",\"dev_api_plugins_twisuki_petcat_index.md\":\"Db-1fmpK\",\"dev_api_plugins_twisuki_petcat_pc_cat.md\":\"F2sC91-N\",\"dev_api_plugins_twisuki_petcat_pc_info.md\":\"CvN9sngp\",\"dev_api_plugins_twisuki_petcat_pc_shop.md\":\"DD4ahNPm\",\"dev_api_plugins_twisuki_petcat_pc_token.md\":\"DA_UlEtw\",\"dev_api_tools_marshoai_bangumi_index.md\":\"DBTSrMfh\",\"dev_api_tools_marshoai_basic_index.md\":\"CiW7yIwW\",\"dev_api_tools_marshoai_megakits_index.md\":\"REZMb3dg\",\"dev_api_tools_marshoai_megakits_mk_common.md\":\"7APNTo8M\",\"dev_api_tools_marshoai_megakits_mk_info.md\":\"ChkkoB5W\",\"dev_api_tools_marshoai_megakits_mk_morse_code.md\":\"0M_XvS3m\",\"dev_api_tools_marshoai_megakits_mk_nya_code.md\":\"c9sb8PmU\",\"dev_api_tools_marshoai_memory_index.md\":\"CIRx5tJY\",\"dev_api_tools_marshoai_meogirl_index.md\":\"XEkcu-t2\",\"dev_api_tools_marshoai_meogirl_mg_info.md\":\"DPN0C8WV\",\"dev_api_tools_marshoai_meogirl_mg_introduce.md\":\"BlzX94DI\",\"dev_api_tools_marshoai_meogirl_mg_search.md\":\"BBTMELq_\",\"dev_api_tools_wip_marshoai_memory_index.md\":\"Dm4TJCvU\",\"dev_api_util.md\":\"CTudSdNP\",\"dev_api_util_hunyuan.md\":\"Dw50YpRa\",\"dev_extension.md\":\"sCH8l0Kd\",\"dev_index.md\":\"DmkkcOvS\",\"dev_project.md\":\"si_Q_Qol\",\"en_dev_api_azure.md\":\"Cto4HxOQ\",\"en_dev_api_azure_onebot.md\":\"Nh5j0O6E\",\"en_dev_api_config.md\":\"DIBrrPTO\",\"en_dev_api_constants.md\":\"0iXpq-Ec\",\"en_dev_api_deal_latex.md\":\"DUC7j3n2\",\"en_dev_api_dev.md\":\"ZX87ppE0\",\"en_dev_api_hooks.md\":\"BCTjt9JT\",\"en_dev_api_hunyuan.md\":\"CAln-sCp\",\"en_dev_api_index.md\":\"CaKH-82W\",\"en_dev_api_instances.md\":\"qxOeS8ME\",\"en_dev_api_marsho.md\":\"Ca8NCLt_\",\"en_dev_api_marsho_onebot.md\":\"Bp39oSfi\",\"en_dev_api_metadata.md\":\"BMq5AAe8\",\"en_dev_api_models.md\":\"BPby54j6\",\"en_dev_api_observer.md\":\"oTjjwmjn\",\"en_dev_a
|
2025-01-26 11:07:43 +00:00
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|