Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jovyinny/whatsapp-bot-from-document
Deploying chatbot created from document.
https://github.com/jovyinny/whatsapp-bot-from-document
Last synced: 9 days ago
JSON representation
Deploying chatbot created from document.
- Host: GitHub
- URL: https://github.com/jovyinny/whatsapp-bot-from-document
- Owner: jovyinny
- Created: 2023-04-10T05:58:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-24T16:41:38.000Z (over 1 year ago)
- Last Synced: 2024-11-08T11:53:09.177Z (2 months ago)
- Language: Python
- Size: 182 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Whatsapp ChatBot created from document
This is an extended version of [Building a Chatbot from Your Documents with ChatGPT](https://blog.neurotech.africa/how-i-created-a-chatbot-that-transformed-my-company-using-68-documents-and-chatgpt/) to have the bot available in Whatsapp. In this project we are going to use [heyoo](https://github.com/Neurotech-HQ/heyoo) to communicate with [whatsapp cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api/), [OpenAI](https://openai.com/) and [Ngrok](https://ngrok.com/)
## Getting whatsapp creds
To proceed with whatsapp integration, you will need **TOKEN** and **TEST WHATSAPP NUMBER ID** (the library works either with a production phone number, if you have one) which you can get from the [Facebook Developer Portal](https://developers.facebook.com/)
Here are steps to follow for you to get started:
1. [Go to your apps](https://developers.facebook.com/apps)
2. [create an app](https://developers.facebook.com/apps/create/)
3. Select Business >> Business
4. It will prompt you to enter basic app informations
5. It will ask you to add products to your app a. Add WhatsApp Messenger
6. Right there you will see a your `TOKEN` and `TEST WHATSAPP NUMBER` and its `phone_number_id`
7. Lastly verify the number you will be using for testing on the To field.
Once you've followed the above procedures you're ready to start the integration.
## Preparations
1. Create project directory
Lets create our project directory/folder. We are going to make a folder named `whatsapp bot`. You can view our basic [project structure](#project-structure)
```bash
mkdir "Whatsapp bot"
cd "Whatsapp bot"
```
2. Create Virtual environment
It is good practice to have virtual environment for development of your python projects. Lets make a virtual environment named `mybot`. Then activate the environment.
```bash
python3 venv -m mybot
source mybot/bin/activate
```
3. Install packages
Now clone the repo and install necessary packages by running
```bash
git clone https://github.com/jovyinny/whatsapp-bot-from-document.git
cd whatsapp-bot-from-document
pip3 install -r requirements.txt
```
4. Make .env file
Lets make `.env` file in our `whatsapp-bot-from-document` to hold our environment variables or secrets. It will hold our private keys from whatsapp and apenai
Open your `whatsapp-bot-from-document`, add file and add your credentials.
```text
OPENAI-API-KEY ="your openAI API key"
PHONE-NUMBER-ID = "Your whatsapp phone number ID"
WHATSAPP-TOKEN = "Your whatsapp token"
```
## Fire Up your project
Once you have environment variables set, you are ready to fire 🚀 your `main.py` in activated virtual envirnoment.
1. Fire up your python script
```bash
python3 main.py
```
2. Start ngrok
```bash
./ngrok http 5000
```
**`Note:`** Keep the port number the same as used in `main.py`
## Finish up
- Getting public url
After running ngrok command, you will be provided with a public url. The url looks like `https://xxxxxxxxxxx.ngrok.io`
- Setting webhook
With the provided url, follow simple steps at [Setting whatsapp webhook](#setting-whatsapp-webhook).
Open `main.py`, copy the `VERIFY_TOKEN`--> paste into verify token in your whatsapp cloud --> **verify and save**.
- Subscribe to message updates from whatsapp
We are heading a the best part of this journey. Just take time to [subscribe to message topic](#webhook-field-subscription).
- End of our amaizing journey
we are now good to go... Fire up your bot in whatsapp by sending text to the provided test number.
🏁 Check out the sample [below](#sample-bot-test)
## Setting whatsapp webhook
Navigate to your whatsapp cloud account --> `configuration` --> edit --> then paste the url into callback url.
## Webhook field subscription
After veryfing and saving whatsapp webook, navigate to webhook fields --> click `manage` to subscribe to `message` topic.
## Project Structure
Here is our basic project structure. Please upload your documents in `documents` folder before firing the project.
```text
└── Whatsapp bot
└── mybot(virtual env)
└── whatsapp-bot-from-document
├── documents
│ └── sample.txt
├── index
│ └── index.json
├── main.py
├── README.md
└── requirements.txt
```
## Sample bot test
Here is a sample bot after deployement.
## Issues
If you will face any issue with the usage of this blueprint please raise one so as we can quickly fix it as soon as possible