Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/wechaty/bot5-assistant

BOT Friday Club Meeting Assistant BOT
https://github.com/wechaty/bot5-assistant

assistant bot5 meeting plugin wechaty

Last synced: about 1 year ago
JSON representation

BOT Friday Club Meeting Assistant BOT

Awesome Lists containing this project

README 

          
# BOT5 Club Assistant Bot Plugin



[![NPM Version](https://img.shields.io/npm/v/wechaty-bot5-assistant?color=brightgreen)](https://www.npmjs.com/package/wechaty-bot5-assistant)

[![NPM](https://github.com/wechaty/bot5-assistant/workflows/NPM/badge.svg)](https://github.com/wechaty/bot5-assistant/actions?query=workflow%3ANPM)

[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)



BOT5 Meeting Assistant BOT powered by RSVP.ai & Wechaty & XState.



![BOT5 Club](docs/images/caq-bot5-qingyu.webp)



> Blog post: [基于Wechaty+轻语实现会议主持助手，崔安颀，Oct 29, 2021, BOT5 Club](https://bot5.ml/events/seminar-minutes-2021-08/#1--%E4%BC%9A%E8%AE%AE%E4%B8%BB%E6%8C%81%E5%8A%A9%E6%89%8B%E6%9C%BA%E5%99%A8%E4%BA%BA)



## BOT5 Club Seminar Flow Chart



```mermaid

flowchart LR

  Initializing --> Preparing

  Preparing --> Talking

  Talking --> Membershiping

  Membershiping --> Chairshiping

  Chairshiping --> Afterparty

  Afterparty --> Minuting

```



### 0. Initializing



```mermaid

graph LR

  subgraph Initializing

    Loading --> Restoring

  end

```



```mermaid

journey

  title Initializing

  section Loading

    Load state from storage: 3: Bot

  section Restoring

    Set context: 4: Bot

    Set state: 5: Bot

  section Saving

    Save state to storage: 3: Bot

```



### 1. Preparing



```mermaid

graph LR

  subgraph Preparing

    Calling --> Publicity

    Publicity --> Registering

    Registering --> Checkining

    Checkining --> Starting

  end

```



```mermaid

journey

  title Preparing

  section Calling

    Call for chairs/talks: 3: Bot

    Set chairs: 4: Admin

    Set talks: 5: Chair

    Set schedule: 4: Chair

  section Publicity

    Send post image twice per day: 3: Bot

  section Registering

    Register: 3: Member

    Send register image: 4: Bot

  section Checkining

    8/4/2/1h: 3: Bot

    20/10m: 3: Bot

    Check in: 3: Member

    Send checkin image: 4: Bot

  section Starting

    Start: 4: Bot

```



### 2. Talking



```mermaid

graph LR

  subgraph Talking

    Introducing --> Welcoming

    Welcoming --> Retrospecting

    Retrospecting --> Presenting

  end

```



```mermaid

journey

  title Talking

  section Introducing

    Introcude Club: 3: Bot

    Introduce Talks: 4: Admin

  section Welcoming

    Welcome newcomers: 4: Chair

    Self introduction: 3: Newcomer

  section Retrospecting

    Retrospect past seminar: 3: Chair

  section Presenting

    Present talks: 4: Speaker

```



### 3. Membershiping



```mermaid

graph LR

  subgraph Membershiping

    Thanking --> Upgrading

    Upgrading --> Brainstorming

    Brainstorming --> Photoing

  end

```



```mermaid

journey

  title Membershiping

  section Thanking

    Thank speakers: 3: Chair

    Send certificate image: 4: Bot

  section Upgrading

    Newcomer upgrade: 3: Newcomer

    Trail member upgrade: 3: Member

    Member upgrade: 4: Member

    Trail chair upgrade: 4: Chair

    Chair upgrade: 5: Chair

  section Brainstorming

    Brainstorm: 3: Member

  section Photoing

    Photo: 4: Member

```



### 4. Chairshiping



```mermaid

graph LR

  subgraph Chairshiping

    Rotating --> Summerizing

    Summerizing --> Roasting

    Roasting --> Pledging

    Pledging --> Photoing

  end

```



```mermaid

journey

  title Chairshiping

  section Rotating

    Naming: 3: Member

    Voting: 3: Member

    Deciding: 4: Member

  section Summerizing

    Summerize: 3: Chair

  section Roasting

    Roast: 2: Member

  section Pledging

    Pledge: 3: Vice

  section Photoing

    Photo: 4: Member

```



### 5. Afterparty



```mermaid

graph LR

  subgraph Afterparty

    Housekeeping --> Drinking

    Drinking --> Photoing

    Photoing --> Paying

  end

```



```mermaid

journey

  title Afterparty

  section Housekeeping

    Housekeep: 3: Member

  section Drinking

    Drink: 5: Member

  section Photoing

    Photo: 5: Member

  section Paying

    Pay: 3: Member

```



### 6. Minuting



```mermaid

graph LR

  subgraph Minuting

    Recording --> Uploading

    Uploading --> Blogging

  end

```



```mermaid

journey

  title Minuting

  section Downloading

    Download video: 3: Bot

  section Uploading

    Upload video: 3: Bot

  section Blogging

    Post blog PR: 4: Bot

```



See also: [BOT5 Club Chair Manual](http://bot5.ml/manuals/chair/)



## Getting Started



### Step 1: Install



```sh

npm install wechaty-bot5-assistant --save

```



### Step 2: Make a bot



```sh

$ vim mybot.js



import { WechatyBuilder } from 'wechaty'

import { Bot5Assistant } from 'wechaty-bot5-assistant'



const bot = WechatyBuilder.build()



bot.use(Bot5Assistant({

  room: [

    /^BOT5/,

  ]

}))

.on('scan', (url, code) => console.log(`Scan QR Code to login: ${code}\n${url}`))

.on('login', user => console.log(`User ${user} logged in`))

.start()

```



### Step 3: Run



```sh

node mybot.js

```



## Options



```ts

const DEFAULT_CONFIG = {

  // Which room(s) you want the bot to work with.

  // Can be a RegExp (for topic) or a function (filter room instance)

  // E.g. room: function (room) { room.topic().indexOf('我的') > -1 }

  room: [/BOT5/i, 'room_id@chatroom'],

}

```



## RSVP.ai



RSVP.ai is a machine-learning company that provides deep natural language understanding services for conversation-styled applications. It grew out of a collaboration between Tsinghua University and University of Waterloo.



RSVP.ai is a small and dedicated team making the smart machines today become the thinking machines tomorrow.



## Finate State Machine (FSM)



It's a finite state machine, which means it has a finite number of states.



> Huan(202110): the above line is auto generated by GitHub Pilot.



We are trying to use [XState](https://xstate.js.org/) to implement the FSM and using FSM to manage our meeting state transitions.



Currently we are just getting started, you can learn more about the BOT5 Club Meeting FSM at 



## Resources



### Projects



- [Dialogs modeled as finite state machines, Giorgio Robino, Jul 14, 2016](https://solyarisoftware.medium.com/dialoghi-come-macchine-a-stati-41bb748fd5b0)



### Papers



- [Dialog Management for Credit Card Selling via Finite State Machine Using Sentiment Classification in Turkish Language, Gizem Sogancıo ˘ glu et. al., INTELLI 2017 : The Sixth International Conference on Intelligent Systems and Applications (includes InManEnt)](https://www.thinkmind.org/articles/intelli_2017_2_30_60066.pdf)

- [State Machine Based Human-Bot Conversation Model and Services, Shayan Zamanirad et. al., May 9, 2020, CAiSE 2020](https://www.semanticscholar.org/paper/State-Machine-Based-Human-Bot-Conversation-Model-Zamanirad-Benatallah/ffa524c4e247a9f532ea4ddb6407be0c9cc8d301)

- [Tartan: A retrieval-based socialbot powered by a dynamic finite-state machine architecture, George Larionov, 4 Dec 2018](https://arxiv.org/abs/1812.01260)

- [A Chatbot by Combining Finite State Machine , Information Retrieval , and Bot-Initiative Strategy, Sanghyun Yi, Published 2017](https://www.semanticscholar.org/paper/A-Chatbot-by-Combining-Finite-State-Machine-%2C-%2C-and-Yi/1fc7c24d80ede54871696e8e44a60fb6d0c8a475)



## History



### main v0.3 (Nov 29, 2021)



1. add `stt()` for convert speech to text



### v0.2 (Oct 29, 2021)



1. Code init in Bot Friday Club meeting

1. Code clean for integrating with [Friday BOT](https://github.com/wechaty/friday)

1. Add XState FSM support



## Author



- [@caq](https://github.com/caq), [Anqi CUI](http://me.caq9.info/), Co-founder & Chief AI Officer of [RSVP.ai](https://rsvp.ai/)

- [@huan](https://github.com/huan), Huan LI, Founding chairman of [BOT5 Club](https://bot5.ml), author of [Wechaty](https://wechaty.js.org)



## Reference



- [Wechaty](https://github.com/wechaty/wechaty)



### Silk to Text



- [Tencent Cloud - 文档中心 > 语音识别 > API 文档 > 录音文件识别极速版相关接口 > 录音文件识别极速版](https://cloud.tencent.com/document/product/1093/52097)



## Copyright & License



- Code & Docs © 2021-now Wechaty Contributors

- Code released under the Apache-2.0 License

- Docs released under Creative Commons