# chatsNextPluginExample

**Repository Path**: Nomicroorsoft/chatsnextpluginexample

## Basic Information

- **Project Name**: chatsNextPluginExample
- **Description**: No description available
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-23
- **Last Updated**: 2026-01-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# chatsNextPluginExample
尽量减少内部的库调用
## 可以使用的变量

|变量名|作用|
|ChatsNextIP|获取请求者ip|

## config.json

|字段|描述|
|---|---|
|package_name|包名，会显示在介绍页面|
|version|包的版本号，会显示在介绍页面|
|description|包的描述，会显示在介绍页面|
|creator|创建者名字|
|addition_prompt_first|第一次openai请求附加提示|
|addition_prompt_next|第二次openai请求附加提示|
|alert|提示信息，在函数被调用的时候出现在用户页面|

`function`字段定义了一个函数，包含以下子字段：

|字段|描述|
|---|---|
|name|函数名,必须和导出的函数名字完全一样|
|description|函数描述，告诉openai如何调用函数|

`generate_parameters`字段定义了函数的参数生成规则帮助chatgpt生成参数，包含以下子字段：

|字段|描述|
|---|---|
|type|参数类型，这里是`object`。|
|properties|参数属性，这里定义了一个名为`format`的字符串参数，它有几个预定义的选项，包括`%Y-%m-%d %H:%M:%S`、`%Y-%m-%d %H:%M`、`%Y-%m-%d`、`%H:%M:%S`和`%H:%M`。|
|required|必需的参数，这里只有`format`。|

`parameters`字段定义了函数从应用获取的参数，这里是`ChatsNextIP`。

# 如何导出函数

- 插件包的根目录下创建main.py导出的函数必须在main.py内部
- 导出的函数必须返回三个参数
    - 第一个参数为float表示这次调用将花费用户多少余额
    - 第二个参数为list，表示插件附加的回复消息，会出现在chatgpt的消息下面
    - 第三个参数是string，表示插件返回给gpt的消息

* 每个包只能导出一个函数