Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hbollon/gobot
🤖 Messenger chatbot using the Levenshtein distance algorithm for pattern matching. Easily configurable with yaml files. Use mux and yaml.v2.
https://github.com/hbollon/gobot
algorithm bot chatbot facebook facebook-api facebook-messenger go golang levenshtein levenshtein-distance messenger messenger-api messenger-bot messenger-chatbot mux pattern-matching yaml
Last synced: 23 days ago
JSON representation
🤖 Messenger chatbot using the Levenshtein distance algorithm for pattern matching. Easily configurable with yaml files. Use mux and yaml.v2.
- Host: GitHub
- URL: https://github.com/hbollon/gobot
- Owner: hbollon
- License: mit
- Created: 2020-07-31T16:08:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-29T15:16:47.000Z (about 4 years ago)
- Last Synced: 2024-10-10T18:27:36.195Z (about 1 month ago)
- Topics: algorithm, bot, chatbot, facebook, facebook-api, facebook-messenger, go, golang, levenshtein, levenshtein-distance, messenger, messenger-api, messenger-bot, messenger-chatbot, mux, pattern-matching, yaml
- Language: Go
- Homepage:
- Size: 44.9 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Gobot : Messenger ChatBot Golang
> Facebook Messenger chatbot using the Levenshtein distance algorithm for pattern matching. Use mux and yaml.v2.
---
## Table of Contents
- [Requirements](#requirements)
- [Presentation](#presentation)
- [Features](#features)
- [Installation](#installation)
- [Customize chatbot responses](#customize-chatbot-responses)
- [Author](#author)
- [Contributing](#-contributing)
- [License](#-license)
---
## Requirements
- [Go](https://golang.org/doc/install)
- Facebook account
## Presentation
This chatbot was developed in order to manage efficiently any facebook page. It use Facebook API.
Gobot use Levenshtein distance algorithm for pattern matching to calculate a match percentage between the received message and templates defined in content.yml in order to be more flexible for the interlocutor instead of only responding to messages that match exactly.
For example, if you have set a minimal matching percentage of 40 % and defined patterns like this in content.yml :
```yaml
templates:
- messages: ["Hello", "Hi"]
response: "Hi !\nI'm GoBot chat bot ! :)"
- messages: ["Who's your creator ?"]
response: "I was build by @hbollon from Bits Please Inc. :)\nMy source code is available on his Github : github.com/hbollon !"
default_response: "Sorry, I don't understand your message... :/\nPlease try again with different sentence or using more words."
```
And someone sends you "Who's build you ?"
It will match with "Who's your creator ?" and send back corresponding response !
Same with "Creator" :)
However, if it doesn't match with any template, it will send the **default_response**.
You can edit the minimal matching percentage in the config.yml file.
## Features
- Designed for Facebook Messenger ✨
- Easily configurable through yaml files ✨
- Efficient pattern matching with Levenshtein distance ✨
- Customizable minimal matching percentage ✨
## Installation
### Clone
- Firstly, clone this repo wherever you want using :
```git
git clone https://github.com/hbollon/gobot
```
### Setup
- Create an app on Facebook developer : https://developers.facebook.com/apps/
- Add it Messenger product and configure your webhook by linking a Facebook page :
- Configure your webhook Callback URL (You can use [Ngrok](https://ngrok.com/) to make public URL to your localhost for testing purpose), the Verify Token and subscribe to messages field:
- Edit configs/config.yml file with your Messenger App credentials :
```yaml
# Facebook API config
app_secret: # Secret key which can be found in the app settings on Facebook Developer dashboard
access_token: # Generated token on app Messenger product
verify_token: # Verify token of your webhook URL
```
You can copy config.yml.exemple to config.yml and replace corresponding values.
- Open bash in root project directory and run :
```bash
go run cmd/gobot/*.go # Run program without build it
# or
go build cmd/gobot/*.go && ./gobot # Build and run
```
## Customize chatbot responses
In order to modify the messages that your chatbot will recognize as well as the responses that it will send back, you just need to modify the content.yml file in the config folder.
Exemple:
```yaml
templates:
- messages: ["Hello", "Hi"]
response: "Hi !\nI'm GoBot chat bot ! :)"
- messages: ["Who's your creator ?"]
response: "I was build by @hbollon from Bits Please Inc. :)\nMy source code is available on his Github : github.com/hbollon !"
default_response: "Sorry, I don't understand your message... :/\nPlease try again with different sentence or using more words."
```
A template is composed of **messages** which are the sentences on which the bot is based to try to understand the interlocutor via the Levenshtein algorithm. If the received message matches one of these messages (depending on the match threshold defined in config.yml) then the response contained in the **response** attribute will be sent to the user.
If received message don't match with any template, the bot will send back the **default_response**.
## Author
👤 **Hugo Bollon**
* Github: [@hbollon](https://github.com/hbollon)
* LinkedIn: [@Hugo Bollon](https://www.linkedin.com/in/hugo-bollon-68a2381a4/)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/hbollon/gobot/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Hugo Bollon](https://github.com/hbollon).
This project is [MIT License](https://github.com/hbollon/gobot/blob/master/LICENSE.md) licensed.