https://github.com/mahmoudajawad/whatsgpt

PoC for OpenAI GPT-3-powered WhatsApp chat bot that extracts information from realtime data
https://github.com/mahmoudajawad/whatsgpt

ai bot chat chatbot conversational-ai conversational-ui whatsapp

Last synced: about 12 hours ago
JSON representation

PoC for OpenAI GPT-3-powered WhatsApp chat bot that extracts information from realtime data

• Host: GitHub
• URL: https://github.com/mahmoudajawad/whatsgpt
• Owner: mahmoudajawad
• License: agpl-3.0
• Created: 2023-03-11T06:17:33.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-20T10:19:01.000Z (almost 2 years ago)
• Last Synced: 2024-11-16T03:26:10.023Z (2 months ago)
• Topics: ai, bot, chat, chatbot, conversational-ai, conversational-ui, whatsapp
• Language: Python
• Homepage:
• Size: 66.4 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WhatsGPT

> WhatsApp is a trademark of Meta, inc.

WhatsGPT is a Proof-of-Concept project to build a WhatsApp chat bot using official [WhatsApp API](https://business.whatsapp.com/developers/developer-hub). The bot would be powered by OpenAI GPT-3 to interpret messages sent to it, and fulfil it against realtime data that [Backend](./backend/README.md) module has access to.

## How to Use

Main component of the project is [Backend](./backend/README.md). To start it, you can choose one of the following three options:

1. Start Backend from python directly: Follow [Contributing Guidelines](./backend/CONTRIBUTING.md) to create Python `venv` and install `requirements` only (it is safe to skip `dev_requirements`), set working directory to Backend, and start it using `python .`.

2. Run docker image\*: Set working directory to Backend, build image using `docker build -t whatsgpt-backend .`, and run it with `docker run --rm -it whatsgpt-backend`.

3. Run docker-compose\*: Set working directory to project root, and run docker-compose as `docker-compose up`. When done stop it with `docker-compose down`. If you have pulled updates to Backend, or you made your own, run it as `docker-compose up --build` to force rebuilding image of Backend.

\* If you are using podman, you can follow the same steps as docker, docker-compose.

## Features To-do List

Following serves as quick overview to project progress:

- [x] WhatsApp API Webhook:

  - [x] User should be able to send message to chat bot.

  - [x] User should receive an echo to message he sent.

- [x] GPT-3 Integration:

  - [x] Rather than getting echo of the message, User should receive an answer as provided by GPT-3.

- [ ] Realtime Data Integration:

  - [ ] Rather than getting responses compiled by GPT-3, User should receive an answer that reflect information bound to realtime data.

- [ ] Messages Log:

  - [ ] Admin should be able to view a log of all messages and responses from Dashboard.

  - [ ] Admin should be able to mark certain messages with different markers for later action.

## Technical Details

- This project will use a monorepo to structure all of its component.

- It will use Python with [AIOHttp](https://pypi.org/project/aiohttp/) to build [Backend]('./backend/README.md').

- It will use [MongoDB](https://www.mongodb.com) as Database.

- It will use [Qwik](https://qwik.builder.io/) to build Dashboard.