summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md133
1 files changed, 47 insertions, 86 deletions
diff --git a/README.md b/README.md
index 3366bb31..a2ec683c 100644
--- a/README.md
+++ b/README.md
@@ -1,63 +1,5 @@
-We got a takedown request by openAI's legal team...
+##### You may join our discord server for updates and 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:
-
-```
-There once was a time, in a land full of code,
-A little boy sat, in his humble abode.
-He tinkered and toyed with devtools galore,
-And found himself curious, and eager for more.
-
-He copied and pasted, with glee and delight,
-A personal project, to last him the night.
-For use academic, and also for fun,
-This little boy's race he just started to run.
-
-Now quite far removed, in a tower so grand,
-A company stood, it was ruling the land.
-Their software was mighty, their power supreme,
-But they never expected this boy and his dream.
-
-As he played with their code, they then started to fear,
-"His project is free! What of money so dear?"
-They panicked and worried, their faces turned red,
-As visions of chaos now filled every head.
-
-The CEO paced, in his office so wide,
-His minions all scrambled, and trying to hide.
-"Who is this bad child?" he cried out in alarm,
-"Our great AI moat, why would he cause harm?"
-
-The developers gathered, their keyboards ablaze,
-To analyze closely the boy's evil ways.
-They studied his project, they cracked every tome,
-And soon they discovered his small, humble home.
-
-"We must stop him!" they cried, with a shout and a shiver,
-"This little boy's Mᴀᴋɪɴɢ OUR COMPANY QUIVER!"
-So they plotted and schemed to yet halt his advance,
-To put an end to his dear digital dance.
-
-They filed then with GitHub a claim most obscene,
-"His code is not his," said the company team,
-Because of the law, the Great Copyright Mess,
-This little boy got his first takedown request.
-
-Now new information we do not yet know,
-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 )
-
-
-_____________________________
-
-
-##### 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,17 +8,16 @@ 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 |
| ------- | ----------- | ---- | ------ |
@@ -91,7 +32,7 @@ Please note the following:
| **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) |
+| `theb` | Example usage for theb (gpt-3.5) | [![Link to File](https://img.shields.io/badge/Link-Go%20to%20File-blue)](gpt4free/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) |
@@ -99,10 +40,9 @@ Please note the following:
| 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,44 +51,53 @@ 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
```
@@ -157,20 +106,31 @@ Another way - docker-compose (no docker build/run needed)
docker-compose up -d
```
+## 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
@@ -188,4 +148,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)