decentralising the Ai Industry, just some language model api's...
Go to file
2024-03-03 11:34:56 +01:00
.github Add new Client API with Docs 2024-02-12 11:41:27 +01:00
docker Add aiohttp_socks to requirements 2024-01-29 18:14:46 +01:00
docs Fix some typos 2024-02-24 02:07:01 +01:00
etc Change uses of whitelist to allowlist in translate_readme.py. 2024-02-26 15:28:28 +08:00
g4f Improve gui handling, Improve count tokens 2024-03-03 11:34:56 +01:00
.gitattributes ~ 2023-08-14 01:04:42 +02:00
.gitignore ~ 2024-01-11 22:40:32 +00:00
.gitpod.yml Create .gitpod.yml 2023-10-30 01:06:52 +05:30
CODE_OF_CONDUCT.md ~ 2023-08-14 01:04:42 +02:00
CONTRIBUTING.md ~ 2023-08-14 01:04:42 +02:00
docker-compose.yml Change default port for gui 2023-12-11 02:50:33 +01:00
LEGAL_NOTICE.md ~ 2024-01-23 12:56:56 +00:00
LICENSE ~ 2023-08-14 01:04:42 +02:00
MANIFEST.in make sure npm is added to lib 2023-11-06 23:29:54 +01:00
README-DE.md Change GeekGPT and FakeGPT status to inactive as owner statement: https://linux.do/t/topic/1051 2024-02-05 18:29:15 +07:00
README.md Update README.md 2024-02-26 12:12:29 +01:00
requirements-min.txt New minimum requirements (#1515) 2024-01-26 07:54:13 +01:00
requirements.txt Add GeminiPro API provider 2024-02-23 11:33:38 +01:00
SECURITY.md ~ 2023-08-14 01:04:42 +02:00
setup.py Add GeminiPro API provider 2024-02-23 11:33:38 +01:00

248433934-7886223b-c1d1-4260-82aa-da5741f303bb 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 an API package with multi-provider requests, with features like timeouts, load balance and flow control.

Note

Lastet version: PyPI version Docker version
Stats: Downloads Downloads

pip install -U g4f
docker pull hlohaus789/g4f

🆕 What's New

🔻 Site Takedown

Is your site on this repository and you want to take it down? Send an email to 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 and Todo

You can always leave some feedback here: https://forms.gle/FeWV9RLEedfdkmFN6

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, use g4f.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

🛠️ Getting Started

Docker container

Quick start:
  1. Download and install Docker
  2. 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
  1. Open the included client on: http://localhost:8080/chat/ or set the API base in your client to: http://localhost:1337/v1
  2. (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:
  1. Download and install Python (Version 3.10+ is recommended).
  2. 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

Image with cat

Full Documentation for Python API

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 ✔️ ✔️ Active
liaobots.site g4f.Provider.Liaobots ✔️ ✔️ ✔️ Active
chat.openai.com g4f.Provider.OpenaiChat ✔️ ✔️ ✔️ Unknown ✔️
raycast.com g4f.Provider.Raycast ✔️ ✔️ ✔️ Unknown ✔️
you.com g4f.Provider.You ✔️ ✔️ ✔️ Active
chat.geekgpt.org g4f.Provider.GeekGpt ✔️ ✔️ ✔️ Inactive

GPT-3.5

Website Provider GPT-3.5 GPT-4 Stream Status Auth
chat3.aiyunos.top g4f.Provider.AItianhuSpace ✔️ ✔️ Unknown
aichatonline.org g4f.Provider.AiChatOnline ✔️ ✔️ Unknown
openchat.team g4f.Provider.Aura ✔️ ✔️ Active
chatbase.co g4f.Provider.ChatBase ✔️ ✔️ Unknown
chatforai.store g4f.Provider.ChatForAi ✔️ ✔️ Unknown
chatgpt.ai g4f.Provider.ChatgptAi ✔️ ✔️ Unknown
chat.chatgptdemo.net g4f.Provider.ChatgptDemo ✔️ ✔️ Unknown
chatgpt-free.cc g4f.Provider.ChatgptNext ✔️ ✔️ Unknown
chat.3211000.xyz g4f.Provider.Chatxyz ✔️ ✔️ Unknown
gptalk.net g4f.Provider.GPTalk ✔️ ✔️ Unknown
gpt6.ai g4f.Provider.Gpt6 ✔️ ✔️ Unknown
gptchatly.com g4f.Provider.GptChatly ✔️ Unknown
ai18.gptforlove.com g4f.Provider.GptForLove ✔️ ✔️ Unknown
gptgo.ai g4f.Provider.GptGo ✔️ ✔️ Unknown
gpttalk.ru g4f.Provider.GptTalkRu ✔️ ✔️ Unknown
koala.sh g4f.Provider.Koala ✔️ ✔️ Active
app.myshell.ai g4f.Provider.MyShell ✔️ ✔️ Unknown
onlinegpt.org g4f.Provider.OnlineGpt ✔️ ✔️ Unknown
perplexity.ai g4f.Provider.PerplexityAi ✔️ ✔️ Unknown
poe.com g4f.Provider.Poe ✔️ ✔️ Unknown ✔️
talkai.info g4f.Provider.TalkAi ✔️ ✔️ Unknown
aitianhu.com g4f.Provider.AItianhu ✔️ ✔️ Inactive
e.aiask.me g4f.Provider.AiAsk ✔️ ✔️ Inactive
chatgpt.bestim.org g4f.Provider.Bestim ✔️ ✔️ Inactive
chatanywhere.cn g4f.Provider.ChatAnywhere ✔️ ✔️ Inactive
chatgpt4online.org g4f.Provider.Chatgpt4Online ✔️ ✔️ Inactive
chat.chatgptdemo.ai g4f.Provider.ChatgptDemoAi ✔️ ✔️ Inactive
chatgptfree.ai g4f.Provider.ChatgptFree ✔️ Inactive
chatgptlogin.ai g4f.Provider.ChatgptLogin ✔️ ✔️ Inactive
chatgptx.de g4f.Provider.ChatgptX ✔️ ✔️ Inactive
chat-shared2.zhile.io g4f.Provider.FakeGpt ✔️ ✔️ Inactive
freegpts1.aifree.site g4f.Provider.FreeGpt ✔️ ✔️ Inactive
gptgod.site g4f.Provider.GptGod ✔️ ✔️ Inactive
hashnode.com g4f.Provider.Hashnode ✔️ ✔️ Inactive
sdk.vercel.ai g4f.Provider.Vercel ✔️ ✔️ Inactive
chat.ylokh.xyz g4f.Provider.Ylokh ✔️ ✔️ Inactive

Other

Website Provider GPT-3.5 GPT-4 Stream Status Auth
bard.google.com g4f.Provider.Bard Unknown ✔️
deepinfra.com g4f.Provider.DeepInfra ✔️ Active
gemini.google.com g4f.Provider.Gemini ✔️ Active ✔️
ai.google.dev g4f.Provider.GeminiPro ✔️ Unknown
gemini-chatbot-sigma.vercel.app g4f.Provider.GeminiProChat ✔️ ✔️ Active
huggingface.co g4f.Provider.HuggingChat ✔️ Unknown
llama2.ai g4f.Provider.Llama2 ✔️ Active
labs.perplexity.ai g4f.Provider.PerplexityLabs ✔️ Active
phind.com g4f.Provider.Phind ✔️ Unknown
pi.ai g4f.Provider.Pi ✔️ Unknown
beta.theb.ai g4f.Provider.Theb ✔️ ✔️ ✔️ Unknown
free.chatgpt.org.uk g4f.Provider.FreeChatgpt ✔️ ✔️ ✔️ Unknown
theb.ai g4f.Provider.ThebApi Unknown ✔️
open-assistant.io g4f.Provider.OpenAssistant ✔️ Inactive ✔️

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 Google g4f.Provider.Gemini gemini.google.com
gemini-pro Google 2+ Providers gemini.google.com
claude-v2 Anthropic 2+ Providers anthropic.com
pi Inflection g4f.Provider.Pi inflection.ai
🎁 Projects Stars 📚 Forks 🛎 Issues 📬 Pull requests
gpt4free Stars Forks Issues Pull Requests
gpt4free-ts Stars Forks Issues Pull Requests
Free AI API's & Potential Providers List Stars Forks Issues Pull Requests
ChatGPT-Clone Stars Forks Issues Pull Requests
ChatGpt Discord Bot Stars Forks Issues Pull Requests
Nyx-Bot (Discord) Stars Forks Issues Pull Requests
LangChain gpt4free Stars Forks Issues Pull Requests
ChatGpt Telegram Bot Stars Forks Issues Pull Requests
ChatGpt Line Bot Stars Forks Issues Pull Requests
Action Translate Readme Stars Forks Issues Pull Requests
Langchain Document GPT Stars Forks Issues Pull Requests
python-tgpt Stars Forks Issues Pull Requests

🤝 Contribute

We welcome contributions from the community. Whether you're adding new providers or features, or simply fixing typos and making small improvements, your input is valued. Creating a pull request is all it takes our co-pilot will handle the code review process. Once all changes have been addressed, we'll merge the pull request into the main branch and release the updates at a later time.

Guide: How do i create a new Provider?
Guide: How can AI help me with writing code?

🙌 Contributors

A list of all 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

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

Star History Chart

📄 License


This project is licensed under GNU_GPL_v3.0.

(🔼 Back to top)