基于python-wechaty的群聊助手机器人

[wj-Mcat]

此次活动

开源软件供应链点亮计划

“开源软件供应链点亮计划-暑期2020”（以下简称 暑期2020）是由中科院软件所与 openEuler 社区共同举办的一项面向高校学生的暑期活动，旨在鼓励在校学生积极参与开源软件的开发维护，促进国内优秀开源软件社区的蓬勃发展。
根据项目的难易程度和完成情况，参与者还可获取“开源软件供应链点亮计划-暑期2020”活动奖金和奖杯。 官网：https://isrc.iscas.ac.cn/summer2020 官方新闻：http://www.iscas.ac.cn/xshd2016/xshy2016/202004/t20200426_5563484.html

Wechaty

Wechaty 是一个开源聊天机器人框架SDK，具有高度封装、高可用的特性，支持NodeJs, Python, Go 和Java 等多语言版本。在过去的4年中，服务了数万名开发者，收获了 Github 的 8000 Star。同时配置了完整的DevOps体系并持续按照Apache 的方式管理技术社区。

基于python-wechaty的群聊助手机器人

项目需求

在实际工作和学习过程中，微信作为主要的沟通渠道工具，承载着主要的事件发布任务。可是由于群聊信息是依时间线展开，一旦信息数量过大，将导致历史消息难以寻找。故此时需要一款群聊助手机器人，能够根据引用消息的回复，提取出其中的历史消息，并将其打上对应的标签同时保存到服务器本地。消息是保存在群聊助手机器人内部中，群内人员只需要艾特助手机器人即可查询历史消息，同时会定时清除和展示一定时间段内的历史打标消息，同时还支持手动清除和展示历史打标消息。

请基于python-wechaty制作一个群聊助手机器人，完成群聊消息打标任务。

项目难度

中（奖金：9000元）

导师联系

• 吴京京：Wechaty Committer，Python Wechaty Author 1435130236@qq.com

项目产出目标

• 1.正常运行python-wechaty的ding-dong-bot机器人
• 2.能够在引用消息中提取历史消息和对应标签数据
• 3.定时或手动清除和展示一段时间内的标签数据
• 4.将标签数据存储到数据库中，方便查询和修改

项目技术栈

• 了解python语言
• 熟悉python-wechaty的使用
• python的任务调度器，如apscheduler
• 对聊天机器人感兴趣者优先

相关资料

• what is the chatbot ?
• https://apscheduler.readthedocs.io/en/stable/
• https://github.com/wechaty/python-wechaty
• https://github.com/wechaty/python-wechaty-getting-started
• python-wechaty-getting-started/ding-dong-bot
• https://wechaty.js.org/

[zsh2517]

你好，我是哈尔滨工业大学一名大一的学生，希望参加"基于python-wechaty的群聊助手机器人"项目

目前情况： 没有使用过python-wechaty 但是独立完成多个基于酷Q的聊天机器人（框架是CQHTTP python async SDK） 对于这个项目，技术栈主要需要预先熟悉wechaty API

目前写过符合这两个项目类似需求的QQ机器人。

1. 定时提醒（由于网课其间作业比较散，平台不一，所以做了个QQ机器人到时提醒），当时没有了解apscheduler，所以用的是反复request自身达到定时的效果（根据下一次任务的时间动态调整等待下一次检测的时间，从3s~30min）

2. 对cqhttp python async SDK 二次封装的一个小游戏框架。（这个git库不是最新。后来开发后没有commit和push，都是直接使用），对于指令式的响应（即用户发送一条消息到机器人后机器人进行处理。而非定时任务）进行了封装，可以以模块的形式动态载入不同的模块功能。（例如成语接龙、猜数猜谜、翻译、搜索等等功能均可以实现）。

希望能够加入项目组。谢谢

[wj-Mcat]

@zsh2517 It's greate news that you have enthusiasm and some experience on Bot. We are welcome you attending this project. We will contact with you later, and send your audit result. Please keep an eye on your email, Thanks for your application.

[MrZilinXiao]

Hello! I'm a sophomore from Sichuan University. My application along with the technical blue print has been sent to your email.

Looking forward to your reply.

[wj-Mcat]

@MrZilinXiao Please waiting for result of the audit. Looking forward to your good news.

[kxz18]

Hello!I'm a sophomore from Tsinghua University. My resume and problems of this project have been sent to your email.

Looking forward to your reply.

[wj-Mcat]

@kxz18 I don't receive your email, please make sure the receiving email address is : 1435130236@qq.com

[kxz18]

Sorry, I've re-sent an email to 1435130236@qq.com with 15068701650@163.com as my email address. Looking forward to your reply.

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：07-19

本周完成的成果

打标系统插件以及单元测试，包括通过引用消息进行回复对重要的群聊消息进行打标，并存入本地的数据库。在对应问题被提出时通过搜索存储的打标消息给出相应的回答，如果匹配的答案置信度不高，则提供可能的关键词向用户进行确认。支持展示全部或一定时间段内的打标消息，用户可以对其中的消息进行手动删除或定时删除，打标消息本身也可以提供有效期参数，在过了有效期后自动删除。提供帮助系统，用户可随时查看不同功能的帮助信息。

本周遇到的困难和需要配合的地方

在将不同的功能模块整合到plugin里的时候需要使用微信号进行测试，但是新注册的微信号挂机器人经常被封。自己也在寻找是否有别人不再使用的微信号，也希望有puppet-mock一类的可以进行测试。

下周的开发计划和预计成果

下周将进行定时消息插件的开发，效果为用户用一定格式进行定时消息的设定，由机器人进行定时发送。同时因为插件数量增多，会对文件结构进行一定的重构。

其他需要说明和同步的事项

无

[lijiarui]

blog: https://wechaty.github.io/2020/07/18/python-wechaty-groupchat-assistant-bot/

[huan]

Good job!

[kxz18]

[基于python-wechaty的群聊助手机器人 进度报告

日期：07-26

本周完成的成果

完成定时消息插件和群成员管理（包括删除群聊成员和欢迎新入群成员）插件，并进行了未与puppet交互部分的单元测试。

本周遇到的困难和需要配合的地方

由于小号被封的原因，一直没能进行三个插件实际使用的测试。

下周的开发计划和预计成果

对之前完成的插件进行puppet对接（实际使用的测试），如果时间允许可以开始交互方面的优化。

其他需要说明和同步的事项

暂无

[wj-Mcat]

[基于python-wechaty的群聊助手机器人] 导师评分

日期：07-28

本周进度报告的评分

• [ ] 1: Deliverable not acceptable
• [ ] 2: Deliverable is below expectations
• [ ] 3: Deliverable is OK
• [ ] 4: Deliverable is above expectations
• [x] 5: Deliverable is perfect

其他需要说明和同步的事项

It's a great news that you have completed the whole project. I think we should improve the mock test for python-wechaty groupchat bot to make your bot more robust. Looking forward to your work in the next week.

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：8-2

本周完成的成果

• 重构帮助系统成一个单独的插件，使得可以用字典方式进行自定义功能帮助文档
• 整个四个插件成一个插件作为群聊助手机器人插件
• 完成接入微信进行测试
• 调整部分交互问题

  本周遇到的困难和需要配合的地方

• 不清楚多语言化的软件架构应该怎么做
• python-wechaty中有一些部分还没有实现完全，接口无法使用

  下周的开发计划和预计成果

• 进行开源计划中期的报告以及中期博客的编写
• 尝试deep learning方式进行问题与答案的匹配，预计可以搭完模型

  其他需要说明和同步的事项

  无

[wj-Mcat]

[基于python-wechaty的群聊助手机器人] 导师评分

日期：08-08

本周进度报告的评分

• [ ] 1: Deliverable not acceptable
• [ ] 2: Deliverable is below expectations
• [ ] 3: Deliverable is OK
• [ ] 4: Deliverable is above expectations
• [x] 5: Deliverable is perfect

其他需要说明和同步的事项

Glad to see that he student has completed most part of the project. I think the next work is to improve the stability of bot and extend the power of bot.

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：08-09

本周完成的成果

• 问答系统模型、训练代码，初步尝试训练
• 开源计划中期初稿撰写

  本周遇到的困难和需要配合的地方

• 训练以后模型效果不佳

  下周的开发计划和预计成果

• 仔细阅读参考文献，查找模型或训练代码问题，解决模型表现不佳的问题
• wechaty方面中期blog撰写

  其他需要说明和同步的事项

  无

[kxz18]

[项目名称] 进度报告

日期：08-16

本周完成的成果

• 中期报告及POC博客的撰写
• demo day(presentation & live coding) 视频的拍摄

  本周遇到的困难和需要配合的地方

  暂无

  下周的开发计划和预计成果

• 完成POC博客的提交
• 回到开发过程，调整模型

  其他需要说明和同步的事项

  暂无

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：08-23

本周完成的成果

• 模型搭建完成、调参中
• 由于模型效果不佳，思考了另一个方案，如果下周模型效果仍然不行，选择尝试另一种方法

  本周遇到的困难和需要配合的地方

• 比较难在中文的训练集上复现论文的结果，遇到一定瓶颈，可能需要之后与导师进行交流

  下周的开发计划和预计成果

• 与导师交流尝试解决模型问题，如果不能解决则尝试另一种方案

  其他需要说明和同步的事项

  暂无

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：08-30

本周完成的成果

• 模型调试完成

  本周遇到的困难和需要配合的地方

• 模型一直调不出来，最后发现是数据集不太行，用论文中的数据集就成功了
• 虽然调出来了，但因为数据集领域比较局限，模型泛化能力不太行，以及因为问题-标签的模式和问题-答案的模式匹配任务不一样，所以在一些简单的例子上测试效果不是很好

  下周的开发计划和预计成果

• 尝试直接用预训练的词向量作平均来求句子的embedding

  其他需要说明和同步的事项

• 近期因为考试和夏季学期的原因，进度比较缓慢

[kxz18]

新项目名称：CHAssisT

[wj-Mcat]

新项目名称：CHAssisT

Wonderful project name and logo.

[huangaszaq]

@wj-Mcat That's nice. BTW, how to explain it？

[wj-Mcat]

@kxz18 You can explain it and show him the beautiful logo here. 🔥 🔥 🔥

[kxz18]

This project provides a assitant bot for group/private chat. The name is a combination of "chat" and "assist"(short for assistant). Logo is like this:

[huangaszaq]

Wooooooow! What a wonderful and unforgettable logo! I guess it may be the best logo.

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：09-06

本周完成的成果

• 项目名称更换
• Logo设计
• 项目CI配置

  本周遇到的困难和需要配合的地方

  暂无

  下周的开发计划和预计成果

• 优化项目结构
• 修正定时删除的回复内容bug

  其他需要说明和同步的事项

  暂无

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：09-13

本周完成的成果

• 修正定时删除的回复内容bug
• 对cron类型的输入解析和对应输出代码进行重构

  本周遇到的困难和需要配合的地方

• python的正则表达式算符优先度问题

  下周的开发计划和预计成果

• 对定时任务部分增加持久化储存

  其他需要说明和同步的事项

  暂无

[kxz18]

[基于python-wechaty的群聊助手机器人] 进度报告

日期：09-20

本周完成的成果

• 修正cron类型定时消息的星期数对应bug
• 定时任务部分持久化储存方式调研

  本周遇到的困难和需要配合的地方

• 暂无

  下周的开发计划和预计成果

• 进行终期评审相关事宜

  其他需要说明和同步的事项

  暂无

[huan]

@wj-Mcat Thank you very much for the mentoring!

@kxz18 Thank you very much for joining the Wechaty open source project and finished Summer 2020 successfully!