summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorthebigbone <pacman@duck.com>2023-04-29 15:29:54 +0200
committerthebigbone <pacman@duck.com>2023-04-29 15:29:54 +0200
commit604c40928af18a3f8d43a42699f429ef099f9793 (patch)
tree6ef17c40c18d528ca5c3a7faefc4adc7c3914d34 /README.md
parentUpdate README.md (diff)
downloadgpt4free-604c40928af18a3f8d43a42699f429ef099f9793.tar
gpt4free-604c40928af18a3f8d43a42699f429ef099f9793.tar.gz
gpt4free-604c40928af18a3f8d43a42699f429ef099f9793.tar.bz2
gpt4free-604c40928af18a3f8d43a42699f429ef099f9793.tar.lz
gpt4free-604c40928af18a3f8d43a42699f429ef099f9793.tar.xz
gpt4free-604c40928af18a3f8d43a42699f429ef099f9793.tar.zst
gpt4free-604c40928af18a3f8d43a42699f429ef099f9793.zip
Diffstat (limited to '')
-rw-r--r--README.md119
1 files changed, 69 insertions, 50 deletions
diff --git a/README.md b/README.md
index 0445951e..99181a0c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,5 @@
-We got a takedown request by openAI's legal team...
+discord server for updates / support:
-discord server for updates / support:
- https://discord.gg/gpt4free
here is a lil' poem you can read in the meantime, while I am investigating it:
@@ -51,13 +50,13 @@ But for the boy's good, we hope results show.
For the cause of the True, the Brave and the Right,
Till the long bitter end, will this boy live to fight.
```
-( I did not write it )
+( I did not write it )
-_____________________________
+---
+##### You may join our discord server for updates and support ; )
-##### You may join our discord server for updates and support ; )
- [Discord Link](https://discord.gg/gpt4free)
<img width="1383" alt="image" src="https://user-images.githubusercontent.com/98614666/233799515-1a7cb6a3-b17f-42c4-956d-8d2a0664466f.png">
@@ -66,43 +65,42 @@ Just API's from some language model sites.
## Legal Notice <a name="legal-notice"></a>
-This repository uses third-party APIs and is *not* associated with or endorsed by the API providers. This project is intended **for educational purposes only**. This is just a little personal project. Sites may contact me to improve their security.
+This repository uses third-party APIs and is _not_ associated with or endorsed by the API providers. This project is intended **for educational purposes only**. This is just a little personal project. Sites may contact me to improve their security.
Please note the following:
-1. **Disclaimer**: The APIs, services, and trademarks mentioned in this repository belong to their respective owners. This project is *not* claiming any right over them.
+1. **Disclaimer**: The APIs, services, and trademarks mentioned in this repository belong to their respective owners. This project is _not_ claiming any right over them.
-2. **Responsibility**: The author of this repository is *not* responsible for any consequences arising from the use or misuse of this repository or the content provided by the third-party APIs and any damage or losses caused by users' actions.
+2. **Responsibility**: The author of this repository is _not_ responsible for any consequences arising from the use or misuse of this repository or the content provided by the third-party APIs and any damage or losses caused by users' actions.
3. **Educational Purposes Only**: This repository and its content are provided strictly for educational purposes. By using the information and code provided, users acknowledge that they are using the APIs and models at their own risk and agree to comply with any applicable laws and regulations.
-
## Table of Contents
-| Section | Description | Link | Status |
-| ------- | ----------- | ---- | ------ |
-| **To do list** | List of tasks to be done | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#todo) | - |
-| **Current Sites** | Current websites or platforms that can be used as APIs | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#current-sites) | - |
-| **Best Sites for gpt4** | Recommended websites or platforms for gpt4 | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#best-sites) | - |
-| **Streamlit GPT4Free GUI** | Web-based graphical user interface for interacting with gpt4free | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#streamlit-gpt4free-gui) | - |
-| **Docker** | Instructions on how to run gpt4free in a Docker container | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#docker-instructions) | - |
-| **ChatGPT clone** | A ChatGPT clone with new features and scalability | [![Link to Website](https://img.shields.io/badge/Link-Visit%20Site-blue)](https://chat.chatbot.sex/chat) | - |
-| **How to install** | Instructions on how to install gpt4free | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#install) | - |
-| **Legal Notice** | Legal notice or disclaimer | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#legal-notice) | - |
-| **Copyright** | Copyright information | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#copyright) | - |
-| **Star History** | Star History | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#star-history) | - |
-| **Usage Examples** | | | |
-| `theb` | Example usage for theb (gpt-3.5) | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](openai_rev/theb/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) |
-| `forefront` | Example usage for forefront (gpt-4) | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](gpt4free/forefront/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) | ||
-| `quora (poe)` | Example usage for quora | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](gpt4free/quora/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) |
-| `you` | Example usage for you | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](gpt4free/you/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) |
-| **Try it Out** | | | |
-| Google Colab Jupyter Notebook | Example usage for gpt4free | [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/DanielShemesh/gpt4free-colab/blob/main/gpt4free.ipynb) | - |
-| replit Example (feel free to fork this repl) | Example usage for gpt4free | [![](https://img.shields.io/badge/Open%20in-Replit-1A1E27?logo=replit)](https://replit.com/@gpt4free/gpt4free-webui) | - |
+| Section | Description | Link | Status |
+| -------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | --- | --- |
+| **To do list** | List of tasks to be done | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#todo) | - |
+| **Current Sites** | Current websites or platforms that can be used as APIs | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#current-sites) | - |
+| **Best Sites for gpt4** | Recommended websites or platforms for gpt4 | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#best-sites) | - |
+| **Streamlit GPT4Free GUI** | Web-based graphical user interface for interacting with gpt4free | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#streamlit-gpt4free-gui) | - |
+| **Docker** | Instructions on how to run gpt4free in a Docker container | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#docker-instructions) | - |
+| **ChatGPT clone** | A ChatGPT clone with new features and scalability | [![Link to Website](https://img.shields.io/badge/Link-Visit%20Site-blue)](https://chat.chatbot.sex/chat) | - |
+| **How to install** | Instructions on how to install gpt4free | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#install) | - |
+| **Legal Notice** | Legal notice or disclaimer | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#legal-notice) | - |
+| **Copyright** | Copyright information | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#copyright) | - |
+| **Star History** | Star History | [![Link to Section](https://img.shields.io/badge/Link-Go%20to%20Section-blue)](#star-history) | - |
+| **Usage Examples** | | | |
+| `theb` | Example usage for theb (gpt-3.5) | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](openai_rev/theb/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) |
+| `forefront` | Example usage for forefront (gpt-4) | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](gpt4free/forefront/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) | | |
+| `quora (poe)` | Example usage for quora | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](gpt4free/quora/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) |
+| `you` | Example usage for you | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](gpt4free/you/README.md) | ![Active](https://img.shields.io/badge/Active-brightgreen) |
+| **Try it Out** | | | |
+| Google Colab Jupyter Notebook | Example usage for gpt4free | [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/DanielShemesh/gpt4free-colab/blob/main/gpt4free.ipynb) | - |
+| replit Example (feel free to fork this repl) | Example usage for gpt4free | [![](https://img.shields.io/badge/Open%20in-Replit-1A1E27?logo=replit)](https://replit.com/@gpt4free/gpt4free-webui) | - |
## Todo <a name="todo"></a>
-- [x] Add a GUI for the repo
+- [x] Add a GUI for the repo
- [ ] Make a general package named `gpt4free`, instead of different folders
- [ ] Live api status to know which are down and which can be used
- [ ] Integrate more API's in `./unfinished` as well as other ones in the lists
@@ -111,62 +109,82 @@ Please note the following:
## Current Sites <a name="current-sites"></a>
-| Website s | Model(s) |
-| ---------------------------------------------------- | ------------------------------- |
-| [forefront.ai](https://chat.forefront.ai) | GPT-4/3.5 |
-| [poe.com](https://poe.com) | GPT-4/3.5 |
-| [writesonic.com](https://writesonic.com) | GPT-3.5 / Internet |
-| [t3nsor.com](https://t3nsor.com) | GPT-3.5 |
-| [you.com](https://you.com) | GPT-3.5 / Internet / good search|
-| [sqlchat.ai](https://sqlchat.ai) | GPT-3.5 |
-| [bard.google.com](https://bard.google.com) | custom / search |
-| [bing.com/chat](https://bing.com/chat) | GPT-4/3.5 |
-| [chat.forefront.ai/](https://chat.forefront.ai/) | GPT-4/3.5 |
+| Website s | Model(s) |
+| ------------------------------------------------ | -------------------------------- |
+| [forefront.ai](https://chat.forefront.ai) | GPT-4/3.5 |
+| [poe.com](https://poe.com) | GPT-4/3.5 |
+| [writesonic.com](https://writesonic.com) | GPT-3.5 / Internet |
+| [t3nsor.com](https://t3nsor.com) | GPT-3.5 |
+| [you.com](https://you.com) | GPT-3.5 / Internet / good search |
+| [sqlchat.ai](https://sqlchat.ai) | GPT-3.5 |
+| [bard.google.com](https://bard.google.com) | custom / search |
+| [bing.com/chat](https://bing.com/chat) | GPT-4/3.5 |
+| [chat.forefront.ai/](https://chat.forefront.ai/) | GPT-4/3.5 |
-## Best sites <a name="best-sites"></a>
+## Best sites <a name="best-sites"></a>
#### gpt-4
+
- [`/forefront`](gpt4free/forefront/README.md)
#### gpt-3.5
+
- [`/you`](gpt4free/you/README.md)
-## Install <a name="install"></a>
+## Install <a name="install"></a>
+
Download or clone this GitHub repo
install requirements with:
+
```sh
pip3 install -r requirements.txt
```
## To start gpt4free GUI <a name="streamlit-gpt4free-gui"></a>
-Move `streamlit_app.py` from `./gui` to the base folder
-then run:
+
+Move `streamlit_app.py` from `./gui` to the base folder
+then run:
`streamlit run streamlit_app.py` or `python3 -m streamlit run streamlit_app.py`
## Docker <a name="docker-instructions"></a>
+
Build
+
```
docker build -t gpt4free:latest -f Docker/Dockerfile .
```
+
Run
+
```
docker run -p 8501:8501 gpt4free:latest
```
+## Deploy using docker-compose
+
+Run the following:
+
+```
+docker-compose up -d
+```
+
## ChatGPT clone
-> currently implementing new features and trying to scale it, please be patient it may be unstable
+
+> currently implementing new features and trying to scale it, please be patient it may be unstable
> https://chat.chatbot.sex/chat
-> This site was developed by me and includes **gpt-4/3.5**, **internet access** and **gpt-jailbreak's** like DAN
+> This site was developed by me and includes **gpt-4/3.5**, **internet access** and **gpt-jailbreak's** like DAN
> run locally here: https://github.com/xtekky/chatgpt-clone
-## Copyright:
-This program is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
+## Copyright:
+
+This program is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)
Most code, with the exception of `quora/api.py` (by [ading2210](https://github.com/ading2210)), has been written by me, [xtekky](https://github.com/xtekky).
### Copyright Notice: <a name="copyright"></a>
+
```
-xtekky/gpt4free: multiple reverse engineered language-model api's to decentralise the ai industry.
+xtekky/gpt4free: multiple reverse engineered language-model api's to decentralise the ai industry.
Copyright (C) 2023 xtekky
This program is free software: you can redistribute it and/or modify
@@ -184,4 +202,5 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
```
## Star History <a name="star-history"></a>
+
[![Star History Chart](https://api.star-history.com/svg?repos=xtekky/gpt4free&type=Date)](https://star-history.com/#xtekky/gpt4free)