Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lexiestleszek/scrapegpt
ScrapeGPT is a RAG-based Telegram bot designed to scrape and analyze websites, then answer questions based on the scraped content. The bot utilizes Retrieval Augmented Generation and webscraping to return natural language answers to the user's queries.
https://github.com/lexiestleszek/scrapegpt
crawler huggingface large-language-models llm ollama proxy rag retrieval-augmented-generation robots-txt scraper telegram-bot website-scraper
Last synced: 1 day ago
JSON representation
ScrapeGPT is a RAG-based Telegram bot designed to scrape and analyze websites, then answer questions based on the scraped content. The bot utilizes Retrieval Augmented Generation and webscraping to return natural language answers to the user's queries.
- Host: GitHub
- URL: https://github.com/lexiestleszek/scrapegpt
- Owner: LexiestLeszek
- License: mit
- Created: 2024-02-13T13:17:26.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-17T09:06:56.000Z (9 months ago)
- Last Synced: 2024-11-06T02:36:12.258Z (9 days ago)
- Topics: crawler, huggingface, large-language-models, llm, ollama, proxy, rag, retrieval-augmented-generation, robots-txt, scraper, telegram-bot, website-scraper
- Language: Python
- Homepage:
- Size: 62.5 KB
- Stars: 72
- Watchers: 4
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ScrapeGPT
## Telegram Bot for Web Content Analysis and Question Answering
ScrapeGPT is a Telegram bot designed to scrape and analyze websites, then answer questions based on the scraped content. The bot utilizes advanced natural language processing techniques to provide accurate responses to user queries.
The idea came from the job interview question when I was given an assignment to "study our company website and provide new product recommendations"> I decided to automate the process of studying a whole website and made ScrapeGPT.
Note:
*You don't have to use it as a Telegram bot, at the very end of the scrapeGPT.py there is a commented main() function to use it as CLI.*
*Also, there is an experimental file called scrapeGPT_gradio_app.py, where the same functionality is implemented in the form of Gradio app and using qDrant VectorDB, Ollama and GPT4ALLEmbeddings.*
## Features
- **Web Scraping**: Automatically scrapes text from provided URLs, including PDF files.
- **Context Retrieval**: Utilizes embeddings and retrieval models to extract relevant context from scraped content.
- **Question Answering**: Generates answers to user questions based on the retrieved context.
- **Robots.txt Parsing**: Respects website's robots.txt to avoid scraping restricted areas.
- **Database Management**: Stores scraped content in a database for future reference and quick access.
- **Proxy Support**: Uses rotating proxies to bypass geo-restrictions and anonymize requests.
- **LLM-based**: Supports both public and local LLMs.
## Getting Started
### Installation
To get started with the bot, follow these steps:
1. Clone the repository to your local machine:
```bash
git clone https://github.com/LexiestLeszek/scrapeGPT.git
cd scrapeGPT
```
2. Install the required dependencies:
```bash
pip install -r requirements.txt
```
3. Go to ollama.com and download it
4. download local model:
```bash
ollama pull qwen:1.8b
```
5. Set up your Telegram bot by obtaining a token from the [BotFather](https://core.telegram.org/bots#botfather).
6. Replace `API_TOKEN` in the script with your actual token and don't forget bot's telegram nickname.
7. Run the bot server script:
```bash
python scrapeGPT.py
```
### Usage
Once the bot is running, interact with it on Telegram:
1. Find the bot by its name and open the chat with the bot
2. Send `/start` command to initialize the bot.
3. Provide a website URL to begin analysis.
4. Ask a question regarding the analyzed content, and the bot will respond with an answer.
## Contributing
Contributions are welcome! To contribute:
- Fork the repository.
- Make changes in your fork.
- Submit a pull request with a clear description of your changes.
## License
This project is licensed under the terms of the MIT license. See the LICENSE file for details.
## Contact
If you have any questions or suggestions, feel free to open an issue on GitHub.
## No liability for the Developer
- Usage of this software for attacking targets without prior mutual consent is illegal.
- It is the end user's responsibility to obey all applicable local, state and federal laws.
- Developers of this software assume no liability and are not responsible for any misuse or damage caused by this program
by third parties using the software in violation of laws and regulations.