Skip to main content

NoneBot2 plugin for AI chat with OpenAI API.

Project description

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-chatgpt-api

✨ ChatGPT API 交互插件 ✨

license pypi python

📖 介绍

通过调用 OpenAI API 进行多轮对话、图像生成等任务,支持 ChatGPT、Genimi、DeepSeek 等多个模型。基于 nonebot-plugin-chatgpt 插件进行修改和扩展,提供更高效的 API 调用和自定义配置。

💿 安装

使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行,输入以下指令即可安装:
nb plugin install nonebot-plugin-chatgpt-api
使用包管理器安装 在 nonebot2 项目的插件目录下,打开命令行,根据你使用的包管理器,输入相应的安装命令:
pip
pip install nonebot-plugin-chatgpt-api
pdm
pdm add nonebot-plugin-chatgpt-api
poetry
poetry add nonebot-plugin-chatgpt-api
conda
conda install nonebot-plugin-chatgpt-api

打开 nonebot2 项目的 bot.py 文件,在其中写入:

nonebot.load_plugin('nonebot_plugin_chatgpt_api')

⚙️ 配置

在 nonebot2 项目的 .env 文件中添加下表中的必填配置:

配置项 必填 默认值 说明
chatgpt_api_key OpenAI API 的 API 密钥
chatgpt_base_url None OpenAI API 基础 URL(如果需要配置反向代理)
chatgpt_model gpt-4o 使用的 ChatGPT 模型
chatgpt_bot_name ChatGPT 机器人的名称,在一些特定的回复中会用到
chatgpt_gen_args_json_file None 生成参数的 JSON 文件路径
chatgpt_return_image False 是否将回复以 markdown 格式渲染为图片
chatgpt_cd_time 5 聊天对话的冷却时间(秒)
chatgpt_timeout_time_chat 10 聊天的超时时间(分钟)
chatgpt_timeout_time_setting 5 与设置相关的命令的超时时间(分钟)
chatgpt_timeout_respond True 超时后是否自动回复
chatgpt_log_api_stats True 是否保存 API 调用统计信息
chatgpt_log_system_prompt True 是否保存系统提示词历史
chatgpt_log_chat_history True 是否保存对话历史
chatgpt_log_path ~/.cache/chatgpt_api_call_stats 日志保存路径

🎉 使用

默认配置下,@机器人加任意文本即可开始聊天。

指令 范围 说明
/帮助 群聊/私聊 查看插件的使用帮助
@机器人 提示词 群聊/私聊 修改系统提示词
@机器人 刷新 群聊/私聊 开启新的对话
@机器人 恢复 群聊/私聊 恢复上次的对话

🤝 贡献

🎉 鸣谢

感谢以下开发者对该项目做出的贡献:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_plugin_chatgpt_api-1.0.1.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonebot_plugin_chatgpt_api-1.0.1-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_chatgpt_api-1.0.1.tar.gz.

File metadata

File hashes

Hashes for nonebot_plugin_chatgpt_api-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6cde5ffcd307e5801823b78d6821050b5c0e1352f2efe074808f4225aa9bb0f0
MD5 7999a1796a4d1b81fdd12e660ef7c57b
BLAKE2b-256 6b8ac83dd5b1998cac646525fe2bcaafe8acb2fcdb4c7d44736eae86bd6411c6

See more details on using hashes here.

File details

Details for the file nonebot_plugin_chatgpt_api-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_chatgpt_api-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2591c79e48a59dba6fcc576d405af3cefc998972c46935337a5df4f85f5d897a
MD5 26dcadfe43d7b1f656ca45517f1cda15
BLAKE2b-256 0ab897c944810843fc5ff99dec915b230f233d2772b39250c0686d4353709eb8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page