A nonebot plugin for chatpdf
Project description
nonebot-plugin-chatpdf
介绍
- 本插件灵感来源于最近很火的chatpdf。
- 将需要分析的论文/阅读材料上传到群文件,或者分次发送给机器人,机器人可以对其进行存储分析,然后你可以向其提问有关文章内容、文章概要、对于文章的思考等问题
- 本插件参考了chatpdf-minimal-demo :chatpdf 的最小实现,和文章对话 和How to Code a Project like ChatPDF?
安装
-
手动安装
git clone https://github.com/Alpaca4610/nonebot_plugin_chatpdf.git
下载完成后在bot项目的pyproject.toml文件手动添加插件:
plugin_dirs = ["xxxxxx","xxxxxx",......,"下载完成的插件路径/nonebot-plugin-chatpdf"]
-
使用 pip
pip install nonebot-plugin-chatgpt-chatpdf
配置文件
在Bot根目录下的.env文件中追加如下内容:
OPENAI_API_KEY = key
可选内容:
OPENAI_HTTP_PROXY = "http://127.0.0.1:8001" # 设置代理解决OPENAI的网络问题
使用方法
如果设置了nonebot全局触发前缀,需要在下面的命令前加上设置的前缀。
使用方式1:上传需要分析的txt文件到群文件中
- /file (使用该命令以上传文件的方式启动chatpdf文章分析功能)
- 在一分钟内,上传需要分析的txt文件到群文件中,机器人会对其进行分析并使用OpenAI的API生成embedding文件,分析完成后会返回成功信息
- /chat_pdf (文章分析完成后,使用该命令后面接需要提问的关于文章的问题,机器人会给出答案)
- /delete_all (删除所有缓存文件)
使用方式2:分次发送文本
- /start (使用该命令以分次发送文件的方式启动chatpdf文章分析功能)
- /add (启动之后,在该命令后面添加文章的内容,由于QQ的发送字数限制,可能需要将文章分成若干个可以发送的片段,然后依次使用该命令发送)
- /stop (文章添加完成之后,使用该命令告知机器人,机器人开始分析文章并使用OpenAI的API生成embedding文件)
- /chat_pdf (文章分析完成后,使用该命令后面接需要提问的关于文章的问题,机器人会给出答案)
- /delete_all (删除所有缓存文件)
注意事项
- 分析过程中会在机器人的data文件夹下产生embedding缓存文件,注意缓存占用
- 每次调用/start命令时,都会清除调用者以前的embedding缓存文件
- 插件加载时会删除所有用户的embedding缓存文件
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for nonebot_plugin_chatpdf-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41f9bf7d8354429bcbf8e8171ab6a06fec7936e70afa9a13832d38d4c7d2ffa8 |
|
MD5 | 4b4fc6a51c040d331da2cbc1ad4220ac |
|
BLAKE2b-256 | 3b6f9204c20cac63e0fce5d02fb66575e1c436dcf16544805aee1b5c337e6f5f |
Close
Hashes for nonebot_plugin_chatpdf-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc9bdf5466419d1c3c033fc8d15721cea06df4134417566c37b420faf13b16ce |
|
MD5 | 79322c62174af3af7405a5c2ab40daef |
|
BLAKE2b-256 | c94829bcb953d80aec80ce96e38bb7499703a0b2f74fb8e34e1fd1430576d50d |