Skip to content

Commit

Permalink
Merge pull request #3 from CoToYo/CoToYo-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
CoToYo authored Aug 23, 2023
2 parents 26201b9 + 7a2b8dc commit 8cd4bfa
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# B0Bot API - Bug Zero Bot API
# B0Bot - CyberSecurity News API

B0Bot API is a Flask API that provides recent hacker, cybersecurity news. Users can request the API with or without keywords and get news easily.
In this project, our objective is to develop a CyberSecurity News API tailored for automated bots on social media platforms.

It is a cutting-edge Flask-based API that grants seamless access to the latest cybersecurity and hacker news. Users can effortlessly retrieve news articles either through specific keywords or without, streamlining the information acquisition process.

Once a user requests our API, it retrieves news data from our knowledge base and feeds it to ChatGPT. After ChatGPT processes the data, the API obtains the response and returns it in JSON format.

# High-Level Architecture Diagram

B0Bot API lives inside a Flask API and is powered by LangChain and OpenAI API.
Our API lives inside a Flask API and is powered by LangChain and OpenAI API.

In addition, to keep the knowledge base of news up to date, a scheduled script will be executed on a regular interval to retrieve the most recent cybersecurity news by scraping a list of target news websites and store them into the MongoDB Atlas Database. Everytime a user requests the B0Bot API, news in the database will be read into LangChain's memory and fed to the LLM of OpenAI. Then, answers will be generated based on both OpenAI model and our knowledge base.
In addition, to keep the knowledge base of news up to date, a scheduled script will be executed on a regular interval to retrieve the most recent cybersecurity news by scraping a list of target news websites and store them into the MongoDB Atlas Database. Everytime a user requests the API, news in the database will be read into LangChain's memory and fed to the LLM of OpenAI. Then, answers will be generated based on both OpenAI model and our knowledge base.

<img width="908" alt="image" src="https://github.com/CoToYo/b0bot/assets/56789038/218fdf2b-be27-4222-9119-81c3dc5c4e02">

Expand Down

0 comments on commit 8cd4bfa

Please sign in to comment.