Set a list of providers |
||
---|---|---|
.github | ||
docker | ||
docs | ||
etc | ||
g4f | ||
.gitattributes | ||
.gitignore | ||
.gitpod.yml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LEGAL_NOTICE.md | ||
LICENSE | ||
MANIFEST.in | ||
README-DE.md | ||
README.md | ||
SECURITY.md | ||
docker-compose.yml | ||
requirements-min.txt | ||
requirements.txt | ||
setup.py |
README.md
Written by @xtekky & maintained by @hlohaus
By using this repository or any code related to it, you agree to the legal notice. The author is not responsible for the usage of this repository nor endorses it, nor is the author responsible for any copies, forks, re-uploads made by other users, or anything else related to GPT4Free. This is the author's only account and repository. To prevent impersonation or irresponsible actions, please comply with the GNU GPL license this Repository uses.
[!Warning] "gpt4free" serves as a PoC (proof of concept), demonstrating the development of a an api package with multi-provider requests, with features like timeouts, load balance and flow control.
pip install -U g4f
docker pull hlohaus789/g4f
🆕 What's New 🚀
- How do I use my smartphone📱 to run g4f? /docs/guides/phone
- Join our Telegram Channel: t.me/g4f_channel
- Join our Discord Group: discord.gg/XfybzPXPH5
Site Takedown
Is your site on this repository and you want to take it down ? email takedown@g4f.ai with proof it is yours and it will be removed as fast as possible. - to prevent reproduction please secure your api ; )
Feedback
You can always leave some feedback here: https://forms.gle/FeWV9RLEedfdkmFN6
To do
As per the survey, here is a list of improvements to come
- update the repository to include the new openai library syntax (ex:
Openai()
class) | completed, useg4f.client.Client
- golang implementation
- 🚧 Improve Documentation (in /docs & Guides, Howtos, & Do video tutorials
- Improve the provider status list & updates
- Tutorials on how to reverse sites to write your own wrapper (PoC only ofc)
- Improve the Bing wrapper. (might write a new wrapper in golang as it is very fast)
- Write a standard provider performance test to improve the stability
- Potential support and development of local models
- 🚧 improve compatibility and error handling
📚 Table of Contents
- 🆕 What's New
- 📚 Table of Contents
- 🛠️ Getting Started
- 💡 Usage
- 🚀 Providers and Models
- 🔗 Related GPT4Free Projects
- 🤝 Contribute
- 🙌 Contributors
- ©️ Copyright
- ⭐ Star History
- 📄 License
🛠️ Getting Started
Docker container
Quick start:
- Download and install Docker
- Pull latest image and run the container:
docker pull hlohaus789/g4f
docker run -p 8080:8080 -p 1337:1337 -p 7900:7900 --shm-size="2g" hlohaus789/g4f:latest
- Open the included client on: http://localhost:8080/chat/ or set the api base in your client to: http://localhost:1337/v1
- (Optional) If you need to log in to a provider, you can view the desktop from the container here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret.
Use your smartphone:
Run the Web UI on Your Smartphone:
Use python
Prerequisites:
- Download and install Python (Version 3.10+ is recommended).
- Install Google Chrome for providers with webdriver
Install using PyPI package:
pip install -U g4f[all]
How do I install only parts or do disable parts? Use partial requirements: /docs/requirements
Install from source:
How do I load the project using git and installing the project requirements? Read this tutorial and follow it step by step: /docs/git
Install using Docker:
How do I build and run composer image from source? Use docker-compose: /docs/docker
💡 Usage
Text Generation
from g4f.client import Client
client = Client()
response = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "Hello"}],
...
)
print(response.choices[0].message.content)
Hello! How can I assist you today?
Image Generation
from g4f.client import Client
client = Client()
response = client.images.generate(
model="gemini",
prompt="a white siamese cat",
...
)
image_url = response.data[0].url
Result:
See also:
- Documentation for the new Client API: /docs/client
- Documentation for the leagcy API: /docs/leagcy
Web UI
To start the web interface, type the following codes in python:
from g4f.gui import run_gui
run_gui()
or execute the following command:
python -m g4f.cli gui -port 8080 -debug
Interference API
You can use the Interference API to serve other OpenAI integrations with G4F.
See: /docs/interference
Configuration
Cookies / Access Token
For generating images with Bing and for the OpenAi Chat you need cookies or a token from your browser session. From Bing you need the "_U" cookie and from OpenAI you need the "access_token". You can pass the cookies / the access token in the create function or you use the set_cookies
setter before you run G4F:
from g4f.cookies import set_cookies
set_cookies(".bing.com", {
"_U": "cookie value"
})
set_cookies("chat.openai.com", {
"access_token": "token value"
})
set_cookies(".google.com", {
"__Secure-1PSID": "cookie value"
})
...
Alternatively, G4F reads the cookies with browser_cookie3
from your browser
or it starts a browser instance with selenium webdriver
for logging in.
Using Proxy
If you want to hide or change your IP address for the providers, you can set a proxy globally via an environment variable:
- On macOS and Linux:
export G4F_PROXY="http://host:port"
- On Windows:
set G4F_PROXY=http://host:port
🚀 Providers and Models
GPT-4
Website | Provider | GPT-3.5 | GPT-4 | Stream | Status | Auth |
---|---|---|---|---|---|---|
bing.com | g4f.Provider.Bing |
❌ | ✔️ | ✔️ | ❌ | |
liaobots.site | g4f.Provider.Liaobots |
✔️ | ✔️ | ✔️ | ❌ | |
chat.openai.com | g4f.Provider.OpenaiChat |
✔️ | ✔️ | ✔️ | ✔️ | |
raycast.com | g4f.Provider.Raycast |
✔️ | ✔️ | ✔️ | ✔️ | |
you.com | g4f.Provider.You |
✔️ | ✔️ | ✔️ | ❌ | |
chat.geekgpt.org | g4f.Provider.GeekGpt |
✔️ | ✔️ | ✔️ | ❌ |
GPT-3.5
Website | Provider | GPT-3.5 | GPT-4 | Stream | Status | Auth |
---|---|---|---|---|---|---|
chat3.aiyunos.top | g4f.Provider.AItianhuSpace |
✔️ | ❌ | ✔️ | ❌ | |
aichatonline.org | g4f.Provider.AiChatOnline |
✔️ | ❌ | ✔️ | ❌ | |
openchat.team | g4f.Provider.Aura |
✔️ | ❌ | ✔️ | ❌ | |
chatbase.co | g4f.Provider.ChatBase |
✔️ | ❌ | ✔️ | ❌ | |
chatforai.store | g4f.Provider.ChatForAi |
✔️ | ❌ | ✔️ | ❌ | |
chatgpt.ai | g4f.Provider.ChatgptAi |
✔️ | ❌ | ✔️ | ❌ | |
chat.chatgptdemo.net | g4f.Provider.ChatgptDemo |
✔️ | ❌ | ✔️ | ❌ | |
chatgpt-free.cc | g4f.Provider.ChatgptNext |
✔️ | ❌ | ✔️ | ❌ | |
chat.3211000.xyz | g4f.Provider.Chatxyz |
✔️ | ❌ | ✔️ | ❌ | |
gptalk.net | g4f.Provider.GPTalk |
✔️ | ❌ | ✔️ | ❌ | |
gpt6.ai | g4f.Provider.Gpt6 |
✔️ | ❌ | ✔️ | ❌ | |
gptchatly.com | g4f.Provider.GptChatly |
✔️ | ❌ | ❌ | ❌ | |
ai18.gptforlove.com | g4f.Provider.GptForLove |
✔️ | ❌ | ✔️ | ❌ | |
gptgo.ai | g4f.Provider.GptGo |
✔️ | ❌ | ✔️ | ❌ | |
gpttalk.ru | g4f.Provider.GptTalkRu |
✔️ | ❌ | ✔️ | ❌ | |
koala.sh | g4f.Provider.Koala |
✔️ | ❌ | ✔️ | ❌ | |
app.myshell.ai | g4f.Provider.MyShell |
✔️ | ❌ | ✔️ | ❌ | |
onlinegpt.org | g4f.Provider.OnlineGpt |
✔️ | ❌ | ✔️ | ❌ | |
perplexity.ai | g4f.Provider.PerplexityAi |
✔️ | ❌ | ✔️ | ❌ | |
poe.com | g4f.Provider.Poe |
✔️ | ❌ | ✔️ | ✔️ | |
talkai.info | g4f.Provider.TalkAi |
✔️ | ❌ | ✔️ | ❌ | |
aitianhu.com | g4f.Provider.AItianhu |
✔️ | ❌ | ✔️ | ❌ | |
e.aiask.me | g4f.Provider.AiAsk |
✔️ | ❌ | ✔️ | ❌ | |
chatgpt.bestim.org | g4f.Provider.Bestim |
✔️ | ❌ | ✔️ | ❌ | |
chatanywhere.cn | g4f.Provider.ChatAnywhere |
✔️ | ❌ | ✔️ | ❌ | |
chatgpt4online.org | g4f.Provider.Chatgpt4Online |
✔️ | ❌ | ✔️ | ❌ | |
chat.chatgptdemo.ai | g4f.Provider.ChatgptDemoAi |
✔️ | ❌ | ✔️ | ❌ | |
chatgptfree.ai | g4f.Provider.ChatgptFree |
✔️ | ❌ | ❌ | ❌ | |
chatgptlogin.ai | g4f.Provider.ChatgptLogin |
✔️ | ❌ | ✔️ | ❌ | |
chatgptx.de | g4f.Provider.ChatgptX |
✔️ | ❌ | ✔️ | ❌ | |
chat-shared2.zhile.io | g4f.Provider.FakeGpt |
✔️ | ❌ | ✔️ | ❌ | |
freegpts1.aifree.site | g4f.Provider.FreeGpt |
✔️ | ❌ | ✔️ | ❌ | |
gptgod.site | g4f.Provider.GptGod |
✔️ | ❌ | ✔️ | ❌ | |
hashnode.com | g4f.Provider.Hashnode |
✔️ | ❌ | ✔️ | ❌ | |
sdk.vercel.ai | g4f.Provider.Vercel |
✔️ | ❌ | ✔️ | ❌ | |
chat.ylokh.xyz | g4f.Provider.Ylokh |
✔️ | ❌ | ✔️ | ❌ |
Other
Website | Provider | GPT-3.5 | GPT-4 | Stream | Status | Auth |
---|---|---|---|---|---|---|
bard.google.com | g4f.Provider.Bard |
❌ | ❌ | ❌ | ✔️ | |
deepinfra.com | g4f.Provider.DeepInfra |
❌ | ❌ | ✔️ | ❌ | |
gemini.google.com | g4f.Provider.Gemini |
❌ | ❌ | ✔️ | ✔️ | |
ai.google.dev | g4f.Provider.GeminiPro |
❌ | ❌ | ✔️ | ❌ | |
gemini-chatbot-sigma.vercel.app | g4f.Provider.GeminiProChat |
✔️ | ❌ | ✔️ | ❌ | |
huggingface.co | g4f.Provider.HuggingChat |
❌ | ❌ | ✔️ | ❌ | |
llama2.ai | g4f.Provider.Llama2 |
❌ | ❌ | ✔️ | ❌ | |
labs.perplexity.ai | g4f.Provider.PerplexityLabs |
❌ | ❌ | ✔️ | ❌ | |
phind.com | g4f.Provider.Phind |
❌ | ❌ | ✔️ | ❌ | |
pi.ai | g4f.Provider.Pi |
❌ | ❌ | ✔️ | ❌ | |
beta.theb.ai | g4f.Provider.Theb |
✔️ | ✔️ | ✔️ | ❌ | |
free.chatgpt.org.uk | g4f.Provider.FreeChatgpt |
✔️ | ✔️ | ✔️ | ❌ | |
theb.ai | g4f.Provider.ThebApi |
❌ | ❌ | ❌ | ✔️ | |
open-assistant.io | g4f.Provider.OpenAssistant |
❌ | ❌ | ✔️ | ✔️ |
Models
Model | Base Provider | Provider | Website |
---|---|---|---|
gpt-3.5-turbo | OpenAI | 5+ Providers | openai.com |
gpt-4 | OpenAI | 2+ Providers | openai.com |
gpt-4-turbo | OpenAI | g4f.Provider.Bing | openai.com |
Llama-2-7b-chat-hf | Meta | 2+ Providers | llama.meta.com |
Llama-2-13b-chat-hf | Meta | 2+ Providers | llama.meta.com |
Llama-2-70b-chat-hf | Meta | 4+ Providers | llama.meta.com |
CodeLlama-34b-Instruct-hf | Meta | 3+ Providers | llama.meta.com |
CodeLlama-70b-Instruct-hf | Meta | g4f.Provider.DeepInfra | llama.meta.com |
Mixtral-8x7B-Instruct-v0.1 | Huggingface | 3+ Providers | huggingface.co |
Mistral-7B-Instruct-v0.1 | Huggingface | 3+ Providers | huggingface.co |
dolphin-2.6-mixtral-8x7b | Huggingface | g4f.Provider.DeepInfra | huggingface.co |
lzlv_70b_fp16_hf | Huggingface | g4f.Provider.DeepInfra | huggingface.co |
airoboros-70b | Huggingface | g4f.Provider.DeepInfra | huggingface.co |
airoboros-l2-70b-gpt4-1.4.1 | Huggingface | g4f.Provider.DeepInfra | huggingface.co |
openchat_3.5 | Huggingface | 2+ Providers | huggingface.co |
gemini | g4f.Provider.Gemini | gemini.google.com | |
gemini-pro | 2+ Providers | gemini.google.com | |
claude-v2 | Anthropic | 2+ Providers | anthropic.com |
pi | Inflection | g4f.Provider.Pi | inflection.ai |
🔗 Related GPT4Free Projects
🎁 Projects | ⭐ Stars | 📚 Forks | 🛎 Issues | 📬 Pull requests |
gpt4free | ||||
gpt4free-ts | ||||
Free AI API's & Potential Providers List | ||||
ChatGPT-Clone | ||||
ChatGpt Discord Bot | ||||
Nyx-Bot (Discord) | ||||
LangChain gpt4free | ||||
ChatGpt Telegram Bot | ||||
ChatGpt Line Bot | ||||
Action Translate Readme | ||||
Langchain Document GPT | ||||
python-tgpt |
🤝 Contribute
Create Provider with AI Tool
Call in your terminal the create_provider.py
script:
python etc/tool/create_provider.py
- Enter your name for the new provider.
- Copy and paste the
cURL
command from your browser developer tools. - Let the AI create the provider for you.
- Customize the provider according to your needs.
Create Provider
- Check out the current list of potential providers, or find your own provider source!
- Create a new file in g4f/Provider with the name of the Provider
- Implement a class that extends BaseProvider.
from __future__ import annotations
from ..typing import AsyncResult, Messages
from .base_provider import AsyncGeneratorProvider
class HogeService(AsyncGeneratorProvider):
url = "https://chat-gpt.com"
working = True
supports_gpt_35_turbo = True
@classmethod
async def create_async_generator(
cls,
model: str,
messages: Messages,
proxy: str = None,
**kwargs
) -> AsyncResult:
yield ""
- Here, you can adjust the settings, for example, if the website does support streaming, set
supports_stream
toTrue
... - Write code to request the provider in
create_async_generator
andyield
the response, even if it's a one-time response, do not hesitate to look at other providers for inspiration - Add the Provider Name in
g4f/Provider/__init__.py
from .HogeService import HogeService
__all__ = [
HogeService,
]
- You are done !, test the provider by calling it:
import g4f
response = g4f.ChatCompletion.create(model='gpt-3.5-turbo', provider=g4f.Provider.PROVIDERNAME,
messages=[{"role": "user", "content": "test"}], stream=g4f.Provider.PROVIDERNAME.supports_stream)
for message in response:
print(message, flush=True, end='')
🙌 Contributors
A list of the contributors is available here
The Vercel.py
file contains code from vercel-llm-api by @ading2210, which is licensed under the GNU GPL v3
Top 1 Contributor: @hlohaus
©️ Copyright
This program is licensed under the GNU GPL v3
xtekky/gpt4free: Copyright (C) 2023 xtekky
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
⭐ Star History
📄 License
|
This project is licensed under GNU_GPL_v3.0. |