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">
|
2025-02-08 15:30:40 +00:00
|
|
|
|
<link rel="preload stylesheet" href="/assets/style.3fMz-wjd.css" as="style">
|
2025-01-26 11:07:43 +00:00
|
|
|
|
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
|
|
|
|
|
|
2025-02-08 15:30:40 +00:00
|
|
|
|
<script type="module" src="/assets/app.DB2-4pOg.js"></script>
|
2025-01-26 11:07:43 +00:00
|
|
|
|
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
2025-02-08 15:30:40 +00:00
|
|
|
|
<link rel="modulepreload" href="/assets/chunks/theme.B1VGcao-.js">
|
|
|
|
|
|
<link rel="modulepreload" href="/assets/chunks/framework.CTVYQtO4.js">
|
|
|
|
|
|
<link rel="modulepreload" href="/assets/dev_extension.md.DfIbM0Ke.lean.js">
|
2025-01-26 11:07:43 +00:00
|
|
|
|
<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>
|
2025-02-08 15:30:40 +00:00
|
|
|
|
<div id="app"><div class="Layout" data-v-f2ef7826><!--[--><!--]--><!--[--><span tabindex="-1" data-v-81e21773></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-81e21773>Skip to content</a><!--]--><!----><header class="VPNav" data-v-f2ef7826 data-v-438f8bce><div class="VPNavBar" data-v-438f8bce data-v-7997f19d><div class="wrapper" data-v-7997f19d><div class="container" data-v-7997f19d><div class="title" data-v-7997f19d><div class="VPNavBarTitle has-sidebar" data-v-7997f19d data-v-8f2b86e4><a class="title" href="/" data-v-8f2b86e4><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-b5ae02ee><!--]--><!--[--><img class="VPImage light logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-b5ae02ee><!--]--><!--]--><!--]--><span data-v-8f2b86e4>小棉智能</span><!--[--><!--]--></a></div></div><div class="content" data-v-7997f19d><div class="content-body" data-v-7997f19d><!--[--><!--]--><div class="VPNavBarSearch search" data-v-7997f19d><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-7997f19d data-v-ec41fe23><span id="main-nav-aria-label" class="visually-hidden" data-v-ec41fe23> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-ec41fe23 data-v-711b3800><!--[--><span data-v-711b3800>家</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/start/use" tabindex="0" data-v-ec41fe23 data-v-711b3800><!--[--><span data-v-711b3800>使用</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/dev/extension" tabindex="0" data-v-ec41fe23 data-v-711b3800><!--[--><span data-v-711b3800>开发</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-7997f19d data-v-e4f4561d data-v-7089f475><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="语言" data-v-7089f475><span class="text" data-v-7089f475><span class="vpi-languages option-icon" data-v-7089f475></span><!----><span class="vpi-chevron-down text-icon" data-v-7089f475></span></span></button><div class="menu" data-v-7089f475><div class="VPMenu" data-v-7089f475 data-v-30cc7172><!----><!--[--><!--[--><div class="items" data-v-e4f4561d><p class="title" data-v-e4f4561d>简体中文</p><!--[--><div class="VPMenuLink" data-v-e4f4561d data-v-acd6ccb4><a class="VPLink link" href="/en/dev/extension" data-v-acd6ccb4><!--[--><span data-v-acd6ccb4>English</span><!--]--></a></div><div class="VPMenuLink" data-v-e4f4561d data-v-acd6ccb4><a class="VPLink link" href="/ja/dev/extension" data-v-acd6ccb4><!--[--><span data-v-acd6ccb4>日本語</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-7997f19d data-v-7f088f89><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-7f088f89 data-v-aedb97ac data-v-4cf15231><span class="check" data-v-4cf15231><span class="icon" data-v-4cf15231><!--[--><span class="vpi-sun sun" data-v-aedb97ac></span><span class="vpi-moon moon" data-v-aedb97ac></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-7997f19d data-v-b364c366 data-v-605e17f0><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai" aria-label="github" target="_blank" rel="noopener" data-v-605e17f0 data-v-bff34bab><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-605e17f0 data-v-bff34bab><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.359266
|
2025-01-26 11:07:43 +00:00
|
|
|
|
<span class="line"></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">__marsho_meta__ </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PluginMetadata(</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> name</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"天气查询"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> author</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"MarshoAI"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</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>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">@on_function_call</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"可以用于查询天气"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span><span style="--shiki-light:#B31D28;--shiki-light-font-style:italic;--shiki-dark:#FDAEB7;--shiki-dark-font-style:italic;">.params(</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> location</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">String(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"地点"</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:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> weather</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(location: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) -> </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # 这里可以调用天气API查询天气，这里只是一个简单的示例</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">location</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">的天气是晴天, 温度是25°C"</span></span></code></pre></div><p>然后将<code>weather.py</code>文件放到<code>$LOCAL_STORE/plugins</code>目录下，重启机器人实例即可。</p><p>接下来AI会根据你的发送的提示词和<code>description</code>来决定调用函数，如<code>查询北京的天气</code>，<code>告诉我东京明天会下雨吗</code>，AI会调用<code>weather</code>函数并传递<code>location</code>参数为<code>北京</code>。</p><h2 id="插件元数据" tabindex="-1">插件元数据 <a class="header-anchor" href="#插件元数据" aria-label="Permalink to "插件元数据""></a></h2><p>元数据是一个名为<code>__marsho_meta__</code>的全局变量，它是一个<code>PluginMetadata</code>对象，至于包含什么熟悉可以查看<code>PluginMetadata</code>类的定义或IDE提示，这里不再赘述。</p><h2 id="函数调用参数" tabindex="-1">函数调用参数 <a class="header-anchor" href="#函数调用参数" aria-label="Permalink to "函数调用参数""></a></h2><p><code>on_function_call</code>装饰器用于标记一个函数为function call，<code>description</code>参数用于描述这个函数的作用，<code>params</code>方法用于定义函数的参数，<code>String</code>、<code>Integer</code>等是OpenAI API接受的参数的类型，<code>description</code>是参数的描述。这些都是给AI看的，AI会根据这些信息来调用函数。</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>参数名不得为<code>placeholder</code>。此参数名是Marsho内部保留的用于保证兼容性的占位参数。</p></div><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">@on_function_call</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"可以用于算命"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span><span style="--shiki-light:#B31D28;--shiki-light-font-style:italic;--shiki-dark:#FDAEB7;--shiki-dark-font-style:italic;">.params(</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> name</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">String(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"姓名"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">),</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> age</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">Integer(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"年龄"</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:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> fortune_telling</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(name: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, age: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">int</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) -> </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">，你的年龄是</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">age</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">岁"</span></span></code></pre></div><h2 id="权限及规则" tabindex="-1">权限及规则 <a class="header-anchor" href="#权限及规则" aria-label="Permalink to "权限及规则""></a></h2><p>插件的调用权限和规则与NoneBot插件一样，使用Caller的permission和rule函数来设置。</p><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">@on_function_call</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"在设备上执行命令"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span><span style="--shiki-light:#B31D28;--shiki-light-font-style:italic;--shiki-dark:#FDAEB7;--shiki-dark-font-style:italic;">.params(</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> command</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">String(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"命令内容"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).permission(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">SUPERUSER</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> execute_command</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(command: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) -> </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> eval</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(command)</span></span></code></pre></div><h2 id="依赖注入" tabindex="-1">依赖注入 <a class="header-anchor" href="#依赖注入" aria-label="Permalink to "依赖注入""></a></h2><p>function call支持NoneBot2原生的会话上下文依赖注入</p><ul><li>Event 及其子类实例</li><li>Bot 及其子类实例</li><li>Matcher 及其子类实例</li><li>T_State</li></ul><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">@on_function_call</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"获取个人信息"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> get_user_info</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(e: Event) -> </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"用户ID: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">e.user_id</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"</span></span>
|
|
|
|
|
|
<span class="line"></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">@on_function_call</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">description</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"获取机器人信息"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
|
|
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> get_bot_info</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(b: Bot) -> </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
2025-02-08 15:30:40 +00:00
|
|
|
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"机器人ID: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">b.self_id</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"</span></span></code></pre></div><h2 id="兼容性" tabindex="-1">兼容性 <a class="header-anchor" href="#兼容性" aria-label="Permalink to "兼容性""></a></h2><p>插件可以编写NoneBot或者轻雪插件的内容，可作为NoneBot插件或者轻雪插件单独发布</p><p>不过，所编写功能仅会在对应的实例上加载对应的功能，如果通过marshoai加载混合插件，那么插件中NoneBot的功能将会依附于marshoai插件， 若通过NoneBot加载包含marshoai功能的NoneBot插件，那么marshoai功能将会依附于NoneBot插件。</p><p><strong>我们建议</strong>：若插件中包含了NoneBot功能，仍然使用marshoai进行加载，这样更符合逻辑。若你想发布为NoneBot插件，请注意<code>require("nonebot_plugin_marshoai")</code>，这是老生常谈了。</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>本质上都是动态导入和注册声明加载，运行时把这些东西塞到一起</p></div><h2 id="插件热重载" tabindex="-1">插件热重载 <a class="header-anchor" href="#插件热重载" aria-label="Permalink to "插件热重载""></a></h2><p>插件热重载是一个实验性功能，可以在不重启机器人的情况下更新插件</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>框架无法完全消除之前插件带来的副作用，当开发测试中效果不符合预期时请重启机器人实例</p><p>为了更好地让热重载功能正常工作，尽可能使用函数式的编程风格，以减少副作用的影响</p></div><p>将<code>MARSHOAI_DEVMODE</code>环境变量设置为<code>true</code>，然后在配置的插件目录<code>MARSHOAI_PLUGIN_DIRS</code>下开发插件，当插件发生变化时，机器人会自动变动的插件。</p><h2 id="aigc-自举" tabindex="-1">AIGC 自举 <a class="header-anchor" href="#aigc-自举" aria-label="Permalink to "AIGC 自举""></a></h2><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>该功能为实验性功能，请注意甄别AI的行为，不要让AI执行危险的操作。</p></div><p>function call为AI赋能，实现了文件io操作，AI可以调用function call来读取文档然后给自己编写代码，实现自举。</p><h2 id="其他" tabindex="-1">其他 <a class="header-anchor" href="#其他" aria-label="Permalink to "其他""></a></h2><ul><li>function call支持同步和异步函数</li><li>本文是一个引导，要查看具体功能请查阅<a href="./api/plugin/index">插件 API 文档</a></li></ul></div></div></main><footer class="VPDocFooter" data-v-d9ad38ba data-v-abb507f0><!--[--><!--]--><div class="edit-info" data-v-abb507f0><div class="edit-link" data-v-abb507f0><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/docs/zh/dev/extension.md" target="_blank" rel="noreferrer" data-v-abb507f0><!--[--><span class="vpi-square-pen edit-link-icon" data-v-abb507f0></span> 编辑此页面<!--]--></a></div><div class="last-updated" data-v-abb507f0><p class="VPLastUpdated" data-v-abb507f0 data-v-0a31532b>Last updated: <time datetime="2024-12-29T07:01:10.000Z" data-v-0a31532b></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-abb507f0><span class="visually-hidden" id="doc-footer-aria-label" data-v-abb507f0>Pager</span><div class="pager" data-v-abb507f0><a class="VPLink link pager-link prev" href="/de
|
2025-02-10 15:54:55 +00:00
|
|
|
|
<script>window.__VP_HASH_MAP__=JSON.parse("{\"dev_api_azure.md\":\"B8-f9FUH\",\"dev_api_azure_onebot.md\":\"AF08dydV\",\"dev_api_config.md\":\"Cfe3T77C\",\"dev_api_constants.md\":\"CzodSzEx\",\"dev_api_deal_latex.md\":\"TC9acXCk\",\"dev_api_dev.md\":\"xtZBfvCK\",\"dev_api_hooks.md\":\"Oex5Osbq\",\"dev_api_hunyuan.md\":\"cwjzNkK4\",\"dev_api_index.md\":\"Cm--m-dj\",\"dev_api_instances.md\":\"DWIbF7zd\",\"dev_api_marsho.md\":\"DJniAOYm\",\"dev_api_marsho_onebot.md\":\"CKXlpK6h\",\"dev_api_metadata.md\":\"gXVQsfb6\",\"dev_api_models.md\":\"Cbw0SnoS\",\"dev_api_observer.md\":\"DJa7EQIJ\",\"dev_api_plugin_func_call_caller.md\":\"ChdLIn42\",\"dev_api_plugin_func_call_index.md\":\"BYaO0YMf\",\"dev_api_plugin_func_call_models.md\":\"BqDLHq48\",\"dev_api_plugin_func_call_params.md\":\"5fFv65No\",\"dev_api_plugin_func_call_utils.md\":\"Cc06pgce\",\"dev_api_plugin_index.md\":\"D1cv5Bdt\",\"dev_api_plugin_load.md\":\"BThuue9-\",\"dev_api_plugin_models.md\":\"CMGeDMNV\",\"dev_api_plugin_register.md\":\"BcHWky_t\",\"dev_api_plugin_typing.md\":\"Bvzcc0i7\",\"dev_api_plugin_utils.md\":\"C8C60oh0\",\"dev_api_plugins_builtin_tools_chat.md\":\"EYzBkM7q\",\"dev_api_plugins_builtin_tools_file_io.md\":\"D8stO352\",\"dev_api_plugins_builtin_tools_index.md\":\"BZHQ5NNH\",\"dev_api_plugins_builtin_tools_liteyuki.md\":\"DiKmnkxA\",\"dev_api_plugins_builtin_tools_manager.md\":\"W6867JUV\",\"dev_api_plugins_builtin_tools_network.md\":\"CNUPusyd\",\"dev_api_plugins_builtin_tools_utils.md\":\"DDnRSzzR\",\"dev_api_plugins_marshoai_bangumi_index.md\":\"BLootinZ\",\"dev_api_plugins_marshoai_basic_index.md\":\"mHSCujgc\",\"dev_api_plugins_test_marshoai_basic_index.md\":\"Bi6J7R_z\",\"dev_api_plugins_test_marshoai_memory_command.md\":\"Cw7GmcD9\",\"dev_api_plugins_test_marshoai_memory_config.md\":\"DvFLax41\",\"dev_api_plugins_test_marshoai_memory_index.md\":\"ju9E5a1x\",\"dev_api_plugins_test_random_number_generator.md\":\"CzKwNN4y\",\"dev_api_plugins_test_snowykami_testplugin_index.md\":\"UDPC-Uc5\",\"dev_api_plugins_test_weather_demo.md\":\"-1KDL3oN\",\"dev_api_plugins_twisuki_megakits_index.md\":\"SJwjK6ir\",\"dev_api_plugins_twisuki_megakits_mk_morse_code.md\":\"BigBH96X\",\"dev_api_plugins_twisuki_megakits_mk_nya_code.md\":\"C6N9gA91\",\"dev_api_plugins_twisuki_petcat_index.md\":\"CyrVKk9d\",\"dev_api_plugins_twisuki_petcat_pc_cat.md\":\"Cw1-Jasb\",\"dev_api_plugins_twisuki_petcat_pc_info.md\":\"Hinys1nW\",\"dev_api_plugins_twisuki_petcat_pc_shop.md\":\"B1e0ZSxF\",\"dev_api_plugins_twisuki_petcat_pc_token.md\":\"iG64fH2l\",\"dev_api_tools_marshoai_bangumi_index.md\":\"Duze3TVP\",\"dev_api_tools_marshoai_basic_index.md\":\"BMkA9afb\",\"dev_api_tools_marshoai_megakits_index.md\":\"D48xEWt6\",\"dev_api_tools_marshoai_megakits_mk_common.md\":\"oRuEYCjm\",\"dev_api_tools_marshoai_megakits_mk_info.md\":\"DW5Ec5cn\",\"dev_api_tools_marshoai_megakits_mk_morse_code.md\":\"CmkxAt56\",\"dev_api_tools_marshoai_megakits_mk_nya_code.md\":\"BQAd-_l9\",\"dev_api_tools_marshoai_memory_index.md\":\"9yOjTtrq\",\"dev_api_tools_marshoai_meogirl_index.md\":\"BlcRo3XU\",\"dev_api_tools_marshoai_meogirl_mg_info.md\":\"Cay9kOBk\",\"dev_api_tools_marshoai_meogirl_mg_introduce.md\":\"dL8Yu_O0\",\"dev_api_tools_marshoai_meogirl_mg_search.md\":\"Dr7zV14D\",\"dev_api_tools_wip_marshoai_memory_index.md\":\"C1sn4qQD\",\"dev_api_util.md\":\"bY3K-Z46\",\"dev_api_util_hunyuan.md\":\"BcYu4BNL\",\"dev_extension.md\":\"DfIbM0Ke\",\"dev_index.md\":\"BbZ4wGtm\",\"dev_project.md\":\"CI3gYpYz\",\"en_dev_api_azure.md\":\"DT1uzYnu\",\"en_dev_api_azure_onebot.md\":\"CIa2eHTt\",\"en_dev_api_config.md\":\"DGpQD45h\",\"en_dev_api_constants.md\":\"sXFtrMz7\",\"en_dev_api_deal_latex.md\":\"BU7zmmQG\",\"en_dev_api_dev.md\":\"CIcPV23r\",\"en_dev_api_hooks.md\":\"9nKsutJk\",\"en_dev_api_hunyuan.md\":\"BVjQMbdk\",\"en_dev_api_index.md\":\"DIBcHO1C\",\"en_dev_api_instances.md\":\"Uv5rIROF\",\"en_dev_api_marsho.md\":\"HOpLNnBx\",\"en_dev_api_marsho_onebot.md\":\"Cv_1bxx2\",\"en_dev_api_metadata.md\":\"8d7RngMY\",\"en_dev_api_models.md\":\"CMIk6dnq\",\"en_dev_api_observer.md\":\"BwAsqPFr\",\"en_dev_a
|
2025-01-26 11:07:43 +00:00
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
