mirror of
https://github.com/LiteyukiStudio/nonebot-plugin-marshoai.git
synced 2025-02-12 09:19:57 +08:00
2 lines
19 KiB
JavaScript
2 lines
19 KiB
JavaScript
import{_ as t,c as s,o as e,ae as i}from"./chunks/framework.CTVYQtO4.js";const k=JSON.parse('{"title":"params","description":"","frontmatter":{"title":"params","order":100},"headers":[],"relativePath":"dev/api/plugin/func_call/params.md","filePath":"zh/dev/api/plugin/func_call/params.md","lastUpdated":null}'),r={name:"dev/api/plugin/func_call/params.md"};function n(l,a,o,h,d,p){return e(),s("div",null,a[0]||(a[0]=[i('<h1 id="模块-nonebot-plugin-marshoai-plugin-func-call-params" tabindex="-1"><strong>模块</strong> <code>nonebot_plugin_marshoai.plugin.func_call.params</code> <a class="header-anchor" href="#模块-nonebot-plugin-marshoai-plugin-func-call-params" aria-label="Permalink to "**模块** `nonebot_plugin_marshoai.plugin.func_call.params`""></a></h1><h3 id="var-p" tabindex="-1">var <code>P</code> <a class="header-anchor" href="#var-p" aria-label="Permalink to "var `P`""></a></h3><ul><li><p><strong>说明</strong>: 参数类型泛型</p></li><li><p><strong>默认值</strong>: <code>TypeVar('P', bound='Parameter')</code></p></li></ul><h3 id="class-paramtypes" tabindex="-1"><em><strong>class</strong></em> <code>ParamTypes</code> <a class="header-anchor" href="#class-paramtypes" aria-label="Permalink to "***class*** `ParamTypes`""></a></h3><h4 id="attr-string-string" tabindex="-1"><em><strong>attr</strong></em> <code>STRING = 'string'</code> <a class="header-anchor" href="#attr-string-string" aria-label="Permalink to "***attr*** `STRING = 'string'`""></a></h4><h4 id="attr-integer-integer" tabindex="-1"><em><strong>attr</strong></em> <code>INTEGER = 'integer'</code> <a class="header-anchor" href="#attr-integer-integer" aria-label="Permalink to "***attr*** `INTEGER = 'integer'`""></a></h4><h4 id="attr-array-array" tabindex="-1"><em><strong>attr</strong></em> <code>ARRAY = 'array'</code> <a class="header-anchor" href="#attr-array-array" aria-label="Permalink to "***attr*** `ARRAY = 'array'`""></a></h4><h4 id="attr-object-object" tabindex="-1"><em><strong>attr</strong></em> <code>OBJECT = 'object'</code> <a class="header-anchor" href="#attr-object-object" aria-label="Permalink to "***attr*** `OBJECT = 'object'`""></a></h4><h4 id="attr-boolean-boolean" tabindex="-1"><em><strong>attr</strong></em> <code>BOOLEAN = 'boolean'</code> <a class="header-anchor" href="#attr-boolean-boolean" aria-label="Permalink to "***attr*** `BOOLEAN = 'boolean'`""></a></h4><h4 id="attr-number-number" tabindex="-1"><em><strong>attr</strong></em> <code>NUMBER = 'number'</code> <a class="header-anchor" href="#attr-number-number" aria-label="Permalink to "***attr*** `NUMBER = 'number'`""></a></h4><h3 id="class-parameter-basemodel" tabindex="-1"><em><strong>class</strong></em> <code>Parameter(BaseModel)</code> <a class="header-anchor" href="#class-parameter-basemodel" aria-label="Permalink to "***class*** `Parameter(BaseModel)`""></a></h3><hr><h4 id="func-data-self-dict-str-any" tabindex="-1"><em><strong>func</strong></em> <code>data(self) -> dict[str, Any]</code> <a class="header-anchor" href="#func-data-self-dict-str-any" aria-label="Permalink to "***func*** `data(self) -> dict[str, Any]`""></a></h4><details><summary><b>源代码</b> 或 <a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/func_call/params.py#L46" target="_blank">在GitHub上查看</a></summary><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:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> data</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(self) -> dict[</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, Any]:</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'type'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.type_, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'description'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.description, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{k: v </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">for</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> k, v </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.properties.items() </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> v </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">is</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> not</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}}</span></span></code></pre></div></details><h4 id="attr-type-str-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>type_: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-type-str-no-default" aria-label="Permalink to "***attr*** `type_: str = NO_DEFAULT`""></a></h4><h4 id="attr-description-str-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>description: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-description-str-no-default" aria-label="Permalink to "***attr*** `description: str = NO_DEFAULT`""></a></h4><h4 id="attr-default-any-none" tabindex="-1"><em><strong>attr</strong></em> <code>default: Any = None</code> <a class="header-anchor" href="#attr-default-any-none" aria-label="Permalink to "***attr*** `default: Any = None`""></a></h4><h4 id="attr-properties-dict-str-any" tabindex="-1"><em><strong>attr</strong></em> <code>properties: dict[str, Any] = {}</code> <a class="header-anchor" href="#attr-properties-dict-str-any" aria-label="Permalink to "***attr*** `properties: dict[str, Any] = {}`""></a></h4><h4 id="attr-required-bool-false" tabindex="-1"><em><strong>attr</strong></em> <code>required: bool = False</code> <a class="header-anchor" href="#attr-required-bool-false" aria-label="Permalink to "***attr*** `required: bool = False`""></a></h4><h3 id="class-string-parameter" tabindex="-1"><em><strong>class</strong></em> <code>String(Parameter)</code> <a class="header-anchor" href="#class-string-parameter" aria-label="Permalink to "***class*** `String(Parameter)`""></a></h3><h4 id="attr-type-str-paramtypes-string" tabindex="-1"><em><strong>attr</strong></em> <code>type_: str = ParamTypes.STRING</code> <a class="header-anchor" href="#attr-type-str-paramtypes-string" aria-label="Permalink to "***attr*** `type_: str = ParamTypes.STRING`""></a></h4><h4 id="attr-properties-dict-str-any-field-default-factory-dict" tabindex="-1"><em><strong>attr</strong></em> <code>properties: dict[str, Any] = Field(default_factory=dict)</code> <a class="header-anchor" href="#attr-properties-dict-str-any-field-default-factory-dict" aria-label="Permalink to "***attr*** `properties: dict[str, Any] = Field(default_factory=dict)`""></a></h4><h4 id="attr-enum-list-str-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>enum: list[str] | None = None</code> <a class="header-anchor" href="#attr-enum-list-str-none-none" aria-label="Permalink to "***attr*** `enum: list[str] | None = None`""></a></h4><h3 id="class-integer-parameter" tabindex="-1"><em><strong>class</strong></em> <code>Integer(Parameter)</code> <a class="header-anchor" href="#class-integer-parameter" aria-label="Permalink to "***class*** `Integer(Parameter)`""></a></h3><h4 id="attr-type-str-paramtypes-integer" tabindex="-1"><em><strong>attr</strong></em> <code>type_: str = ParamTypes.INTEGER</code> <a class="header-anchor" href="#attr-type-str-paramtypes-integer" aria-label="Permalink to "***attr*** `type_: str = ParamTypes.INTEGER`""></a></h4><h4 id="attr-properties-dict-str-any-field-default-factory-lambda-minimum-0-maximum-100" tabindex="-1"><em><strong>attr</strong></em> <code>properties: dict[str, Any] = Field(default_factory=lambda: {'minimum': 0, 'maximum': 100})</code> <a class="header-anchor" href="#attr-properties-dict-str-any-field-default-factory-lambda-minimum-0-maximum-100" aria-label="Permalink to "***attr*** `properties: dict[str, Any] = Field(default_factory=lambda: {'minimum': 0, 'maximum': 100})`""></a></h4><h4 id="attr-minimum-int-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>minimum: int | None = None</code> <a class="header-anchor" href="#attr-minimum-int-none-none" aria-label="Permalink to "***attr*** `minimum: int | None = None`""></a></h4><h4 id="attr-maximum-int-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>maximum: int | None = None</code> <a class="header-anchor" href="#attr-maximum-int-none-none" aria-label="Permalink to "***attr*** `maximum: int | None = None`""></a></h4><h3 id="class-array-parameter" tabindex="-1"><em><strong>class</strong></em> <code>Array(Parameter)</code> <a class="header-anchor" href="#class-array-parameter" aria-label="Permalink to "***class*** `Array(Parameter)`""></a></h3><h4 id="attr-type-str-paramtypes-array" tabindex="-1"><em><strong>attr</strong></em> <code>type_: str = ParamTypes.ARRAY</code> <a class="header-anchor" href="#attr-type-str-paramtypes-array" aria-label="Permalink to "***attr*** `type_: str = ParamTypes.ARRAY`""></a></h4><h4 id="attr-properties-dict-str-any-field-default-factory-lambda-items-type-string" tabindex="-1"><em><strong>attr</strong></em> <code>properties: dict[str, Any] = Field(default_factory=lambda: {'items': {'type': 'string'}})</code> <a class="header-anchor" href="#attr-properties-dict-str-any-field-default-factory-lambda-items-type-string" aria-label="Permalink to "***attr*** `properties: dict[str, Any] = Field(default_factory=lambda: {'items': {'type': 'string'}})`""></a></h4><h4 id="attr-items-str-field-string-description-数组元素类型" tabindex="-1"><em><strong>attr</strong></em> <code>items: str = Field('string', description='数组元素类型')</code> <a class="header-anchor" href="#attr-items-str-field-string-description-数组元素类型" aria-label="Permalink to "***attr*** `items: str = Field('string', description='数组元素类型')`""></a></h4><h3 id="class-functioncall-basemodel" tabindex="-1"><em><strong>class</strong></em> <code>FunctionCall(BaseModel)</code> <a class="header-anchor" href="#class-functioncall-basemodel" aria-label="Permalink to "***class*** `FunctionCall(BaseModel)`""></a></h3><hr><h4 id="func-hash-self-int" tabindex="-1"><em><strong>func</strong></em> <code>hash self => int</code> <a class="header-anchor" href="#func-hash-self-int" aria-label="Permalink to "***func*** `hash self => int`""></a></h4><details><summary><b>源代码</b> 或 <a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/func_call/params.py#L104" target="_blank">在GitHub上查看</a></summary><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:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> __hash__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(self) -> </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">int</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> hash</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.name)</span></span></code></pre></div></details><hr><h4 id="func-data-self-dict-str-any-1" tabindex="-1"><em><strong>func</strong></em> <code>data(self) -> dict[str, Any]</code> <a class="header-anchor" href="#func-data-self-dict-str-any-1" aria-label="Permalink to "***func*** `data(self) -> dict[str, Any]`""></a></h4><p><strong>说明</strong>: 生成函数描述信息</p><p><strong>返回</strong>: dict[str, Any]: 函数描述信息 字典</p><details><summary><b>源代码</b> 或 <a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/func_call/params.py#L107" target="_blank">在GitHub上查看</a></summary><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:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> data</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(self) -> dict[</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, Any]:</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'type'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'function'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'function'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'name'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.name, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'description'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.description, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'parameters'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'type'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'object'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'properties'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {k: v.data() </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">for</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> k, v </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.arguments.items()}}, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'required'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [k </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">for</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> k, v </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.arguments.items() </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> v.default </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">is</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">], </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">**</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.kwargs}}</span></span></code></pre></div></details><h4 id="attr-name-str-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>name: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-name-str-no-default" aria-label="Permalink to "***attr*** `name: str = NO_DEFAULT`""></a></h4><h4 id="attr-description-str-no-default-1" tabindex="-1"><em><strong>attr</strong></em> <code>description: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-description-str-no-default-1" aria-label="Permalink to "***attr*** `description: str = NO_DEFAULT`""></a></h4><h4 id="attr-arguments-dict-str-parameter-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>arguments: dict[str, Parameter] = NO_DEFAULT</code> <a class="header-anchor" href="#attr-arguments-dict-str-parameter-no-default" aria-label="Permalink to "***attr*** `arguments: dict[str, Parameter] = NO_DEFAULT`""></a></h4><h4 id="attr-function-function-call-func-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>function: FUNCTION_CALL_FUNC = NO_DEFAULT</code> <a class="header-anchor" href="#attr-function-function-call-func-no-default" aria-label="Permalink to "***attr*** `function: FUNCTION_CALL_FUNC = NO_DEFAULT`""></a></h4><h4 id="attr-kwargs-dict-str-any" tabindex="-1"><em><strong>attr</strong></em> <code>kwargs: dict[str, Any] = {}</code> <a class="header-anchor" href="#attr-kwargs-dict-str-any" aria-label="Permalink to "***attr*** `kwargs: dict[str, Any] = {}`""></a></h4>',46)]))}const m=t(r,[["render",n]]);export{k as __pageData,m as default};
|