本專案只能在win系統運行,基於chatgpt-on-wechat二改,完全使用了來源專案的框架,鳴謝!支援Win平台的PC客戶端以及企微客戶端,本專案會持續更新,也會逐漸開發插件,一個人開發,勿催,感謝!
專案支援的訊息通道及功能如下:
Wework :PC端的企微個人號訊息頻道,依賴ntwork,限制WeCom_4.0.8.6027版本,只能在Win平台運作專案。
Wechat :PC端的個微訊息通道,依賴ntchat項目,最高支援Python310環境版本,限WeChat3.6.0.18版本,只能在Win平台運作專案。
2023.08.15:更新FastGpt接入邏輯,支援單群單一知識庫,未配置預設走全域base。
{ "fast_gpt" : true , "fastgpt_list" : { "R:108864****63985" : " fastgpt-1aps*****pg47-64b16a*******181317 " , "R:107******373863" : " fastgpt-1aps8*****gni1kpg47-64b168*****cd181267 " } }2023.08.08:新增Wework(企微個人號)訊息頻道。
2023.07.25:適添加wechat訊息通道,專案相容FastGPT API接口,直接修改open_ai_api_key和open_ai_api_base即可使用。
僅支援Windows 系統同時需安裝Python
。
建議Python版本在3.7.1~3.10 之間。
(1) 下載項目代碼:
git clone https://github.com/chazzjimel/WeChat-AIChatbot-WinOnly
cd chatgpt-on-wechat/
(2) 安裝核心依賴(必選):
pip3 install -r requirements.txt
(3) 拓展依賴(可選,建議安裝):
pip3 install -r requirements-optional.txt
如果某項依賴安裝失敗請註解掉對應的行再繼續。
其中tiktoken
要求python
版本在3.8以上,它用於精確計算會話使用的tokens數量,強烈建議安裝。
使用google
或baidu
語音辨識需安裝ffmpeg
,
預設的openai
語音辨識不需要安裝ffmpeg
。
參考#415
使用azure
語音功能需安裝依賴,並參考文件的環境需求。 :
pip3 install azure-cognitiveservices-speech
設定檔的範本在根目錄的config-template.json
中,需複製該範本建立最終生效的config.json
檔案:
cp config-template.json config.json
然後在config.json
中填入配置,以下是對預設配置的說明,可依需求進行自訂修改(請去掉註解):
# config.json文件内容示例
{
"open_ai_api_key" : " YOUR API KEY " , # 填入上面创建的 OpenAI API KEY
"model" : " gpt-3.5-turbo " , # 模型名称。当use_azure_chatgpt为true时,其名称为Azure上model deployment名称
"proxy" : " " , # 代理客户端的ip和端口,国内环境开启代理的需要填写该项,如 "127.0.0.1:7890"
"single_chat_prefix" : [ " bot " , " @bot " ], # 私聊时文本需要包含该前缀才能触发机器人回复
"single_chat_reply_prefix" : " [bot] " , # 私聊时自动回复的前缀,用于区分真人
"group_chat_prefix" : [ " @bot " ], # 群聊时包含该前缀则会触发机器人回复
"group_name_white_list" : [ " ChatGPT测试群" , " ChatGPT测试群2 " ], # 开启自动回复的群名称列表
"group_chat_in_one_session" : [ " ChatGPT测试群" ], # 支持会话上下文共享的群名称
"image_create_prefix" : [ "画" , "看" , "找" ], # 开启图片回复的前缀
"conversation_max_tokens" : 1000 , # 支持上下文记忆的最多字符数
"speech_recognition" : false , # 是否开启语音识别
"group_speech_recognition" : false , # 是否开启群组语音识别
"use_azure_chatgpt" : false , # 是否使用Azure ChatGPT service代替openai ChatGPT service. 当设置为true时需要设置 open_ai_api_base,如 https://xxx.openai.azure.com/
"azure_deployment_id" : " " , # 采用Azure ChatGPT时,模型部署名称
"azure_api_version" : " " , # 采用Azure ChatGPT时,API版本
"character_desc" : "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题,并且可以使用多种语言与人交流。 " , # 人格描述
# 订阅消息,公众号和企业微信channel中请填写,当被订阅时会自动回复,可使用特殊占位符。目前支持的占位符有{trigger_prefix } ,在程序中它会自动替换成bot的触发词。
"subscribe_msg" : "感谢您的关注! n这里是ChatGPT,可以自由对话。 n支持语音对话。 n支持图片输出,画字开头的消息将按要求创作图片。 n支持角色扮演和文字冒险等丰富插件。 n输入{trigger_prefix}#help 查看详细指令。 " ,
"accept_friend" : false , # 配置itchat和ntchat自动通过好友请求
"channel_type" : " wx " , #通道类型,支持:{ntchat,wework,weowrktop}
"fast_gpt" : false , # 标识模型接口是否是fastgpt
"ntchat_smart" : false , # 配置ntchat多开,为true时接管当前已登录微信,默认true
"wework_smart" : false , # 配置wework多开,为true时接管当前已登录企业微信,默认true
"fastgpt_list" : {
"R:108864****63985" : " fastgpt-1aps*****pg47-64b16a*******181317 " ,
"R:107******373863" : " fastgpt-1aps8*****gni1kpg47-64b168*****cd181267 "
}, # 每个群聊ID配置对应的key即可实现单群单知识库,未配置的默认
"wework_http" : " http://127.0.0.1:8000 " , # weworktop通道http接口地址,默认127.0.0.1:8000
"wework_callback_port" : 8001 , # weworktop回调端口
"voice_openai_api_key" : " " , # 使用了fasgpt仍然有openai语音识别需求的,要在这里配置一下openai的参数
"voice_openai_api_base" : " " , # 使用了fasgpt仍然有openai语音识别需求的,要在这里配置一下openai的参数
}
配置說明:
1.個人聊天
single_chat_prefix
(如果不需要以前綴觸發可以填寫"single_chat_prefix": [""]
)single_chat_reply_prefix
(如果不需要前綴可以填寫"single_chat_reply_prefix": ""
)2.群組聊天
group_name_white_list
中才能開啟群組聊天自動回覆。如果想要對所有群組聊天生效,可以直接填寫"group_name_white_list": ["ALL_GROUP"]
group_chat_prefix
group_name_keyword_white_list
設定項目支援模糊符合群組名稱, group_chat_keyword
設定項目則支援模糊比對群組訊息內容,用法與上述兩個設定項目相同。 (Contributed by evolay)group_chat_in_one_session
:使群組聊天共用一個會話上下文,設定["ALL_GROUP"]
則作用於所有群組聊天3.語音識別
"speech_recognition": true
將開啟語音識別,預設使用openai的whisper模型識別為文字,同時以文字回复,該參數僅支援私聊(注意由於語音訊息無法匹配前綴,一旦開啟將對所有語音自動回复,支援語音觸發畫圖);"group_speech_recognition": true
將開啟群組語音識別,預設使用openai的whisper模型識別為文字,同時以文字回复,參數僅支援群組聊天(會匹配group_chat_prefix和group_chat_keyword, 支援語音觸發畫圖);"voice_reply_voice": true
將開啟語音回复語音(同時作用於私聊和群聊),但是需要配置對應語音合成平台的key,由於itchat協議的限制,只能發送語音mp3文件,若使用wechaty則回复的是微信語音。4.其他配置
model
: 模型名稱,目前支援gpt-3.5-turbo
, text-davinci-003
, gpt-4
, gpt-4-32k
(其中gpt-4 api暫未完全開放,申請通過後可使用)temperature
, frequency_penalty
, presence_penalty
: Chat API介面參數,詳情參考OpenAI官方文件。proxy
:由於目前openai
介面國內無法存取,需配置代理客戶端的位址,詳情參考#351image_create_prefix
config.py
中檢查哪些參數在本專案中是可設定的。conversation_max_tokens
:表示能夠記憶的上下文最大字數(一問一答為一組對話,如果累積的對話字數超出限制,就會優先移除最早的一組對話)rate_limit_chatgpt
, rate_limit_dalle
:每分鐘最高問答速率、畫圖速率,超速後排隊依序處理。clear_memory_commands
: 對話內指令,主動清空前文記憶,字串陣列可自訂指令別名。hot_reload
: 程式退出後,暫存微信掃碼狀態,預設為關閉。character_desc
配置中保存著你對機器人說的一段話,他會記住這段話並作為他的設定,你可以為他定制任何人格(關於會話上下文的更多內容參考該issue)subscribe_msg
:訂閱訊息,公眾號和企業微信channel中請填寫,當被訂閱時會自動回复, 可使用特殊佔位符。目前支援的佔位符有{trigger_prefix},在程式中它會自動替換成bot的觸發詞。本說明文件可能未及時更新,目前所有選用的組態項目均在該config.py
中列出。
如果是開發機本地運行,直接在專案根目錄下執行:
python3 app.py
1.主項目安裝主要依賴後,還需要安裝ntchat依賴
pip install ntchat
2.安裝指定PC微信版本:WeChat3.6.0.18版本,掃碼登陸好,關閉自動更新微信
3.修改主項目設定項:config.json檔案內
"channel_type" : " ntchat "
4.運行app.py
1.主項目安裝主要依賴後,還需要安裝ntchat依賴
pip install ntwork
2.安裝指定PC企微專用版本:WeCom_4.0.8.6027版本,掃碼登陸好,關閉自動更新企業微信
3.修改主項目設定項:config.json檔案內
"channel_type" : " wework "
4.運行app.py
1.安裝指定PC企微專用版本:WeCom_4.0.8.6027版本,掃碼登陸好,關閉自動更新企業微信
2.修改主項目設定項:config.json檔案內
"channel_type" : " weworktop "
3.管理員運行企微介面程序,基礎版在專案資料夾」WeChat-AIChatbot-WinOnlychannelweworktop「內,運行WeworkApi.exe,不用輸入key直接點擊啟動服務,啟動成功企微開啟後下一步
4.運行app.py