nonebot_plugin_openAI_completions

✨ NoneBot 调用openAI completions接口实现的对话插件 ✨

适用于nonebot2 v11的调用openAI completions接口实现的对话插件，部分源码由chatGPT编写。
调用的相关API源自api.openai.com

🔧 开发环境

Nonebot2：2.0.0b5
python：3.8.13
操作系统：Windows10（Linux兼容性问题不大）
编辑器：VS Code

💿 安装

环境依赖openai库
且需要注册openAI账号，获取secret key，配置env后才能正常使用！

1. nb-cli安装（推荐）

在你bot工程的文件夹下，运行cmd（运行路径要对啊），执行nb命令安装插件，插件配置会自动添加至配置文件

nb plugin install nonebot_plugin_openAI_completions

2. 本地安装

先安装下 openai

pip install openai

将项目clone到你的机器人插件下的对应插件目录内（一般为机器人文件夹下的src/plugins），然后把nonebot_plugin_openAI_completions文件夹里的内容拷贝至上一级目录即可。
clone命令参考（得先装git，懂的都懂）：

git clone https://github.com/Ikaros-521/nonebot_plugin_openAI_completions.git

也可以直接下载压缩包到插件目录解压，然后同样提取nonebot_plugin_openAI_completions至上一级目录。
目录结构： 你的bot/src/plugins/nonebot_plugin_openAI_completions/__init__.py

3. pip安装

pip install nonebot_plugin_openAI_completions

打开 nonebot2 项目的 bot.py 文件, 在其中写入
nonebot.load_plugin('nonebot_plugin_openAI_completions')
当然，如果是默认nb-cli创建的nonebot2的话，在bot路径pyproject.toml的[tool.nonebot]的plugins中添加nonebot_plugin_openAI_completions即可
pyproject.toml配置例如：

[tool.nonebot]
plugin_dirs = ["src/plugins"]
plugins = ["nonebot_plugin_openAI_completions"]

更新版本

nb plugin update nonebot_plugin_openAI_completions

🔧 配置

secret key获取方式

获取 openai 的 secret key 需要您先创建一个 openai 账号，然后在其网站上申请 API key。

具体流程如下：

1、访问 openai 网站（https://beta.openai.com/），点击右上角的“Sign up”按钮进行注册。
2、在注册页面填写相关信息并提交，完成账号创建。
3、登录 openai 网站，点击右上角的“Developer”菜单，进入开发者控制台。
4、在开发者控制台中点击“New API Key”按钮，创建一个新的 API key。
5、在弹出的窗口中输入您的 API key 名称，然后点击“Create”按钮。
6、在创建完成后，您可以在开发者控制台中看到您创建的 API key 的 secret key。

env配置

# 在你的env文件中添加如下配置（我的是.env.prod）  
openai_api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
openai_api_base = 'https://api.openai.com/v1'
openai_model = 'gpt-3.5-turbo'
openai_max_tokens = 16
openai_temperature = 1

配置项	必填	默认值	说明
openai_api_key	是	""	参考上文secret key获取方式
openai_api_base	否	""	api地址，可以配置代理站地址，参考官方文档，默认为'https://api.openai.com/v1'
openai_model	否	""	使用模型，参考官方文档，默认为'gpt-3.5-turbo'
openai_max_tokens	否	""	最大token数，参考官方文档，默认为16
openai_temperature	否	""	温度（回答随机性），参考官方文档，默认为1

🎉 功能

调用openAI的API接口获取请求返回直接输出，简单粗暴。

👉 命令

/cplt 或 /openai 或 /gpt

命令结构：/cplt [你想问的内容]
例如：/cplt 用python实现hello world 或 /openai 你叫什么名字 或 /gpt 今天是什么日子
bot返回内容：

⚙ 拓展

自己动手丰衣足食

📝 更新日志

展开/收起

0.0.1

• 插件初次发布

0.1.0

• 改用官方openai库实现

致谢

• chat.openai.com
• https://platform.openai.com/