gpt4free/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 an API package with multi-provider requests, with features like timeouts, load balance and flow control.

Note

^{Lastet version:
Stats:}

pip install -U g4f

docker pull hlohaus789/g4f

🆕 What's New

• Webview .exe for Windows: 💻 Installation Guide for Windows (.exe)
• Join our Telegram Channel: 📨 telegram.me/g4f_channel
• Join our Discord Group: 💬 discord.gg/XfybzPXPH5
• g4f now supports 100% local inference: 🧠 local-docs

🔻 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. (Wait and Retry or reuse conversation)
• 🚧 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
  • Docker Container Guide
  • Installation Guide for Windows (.exe)
  • Use python
    • Prerequisites
    • Install using PyPI package:
    • Install from source:
    • Install using Docker:
• 💡 Usage
  • Text Generation
  • Image Generation
  • Web UI
  • Interference API
  • Configuration
• 🚀 Providers and Models
  • GPT-4
  • GPT-3.5
  • Other
  • Models
• 🔗 Powered by gpt4free
• 🤝 Contribute
  • How do i create a new Provider?
  • How can AI help me with writing code?
• 🙌 Contributors
• ©️ Copyright
• ⭐ Star History
• 📄 License

🛠️ Getting Started

Docker Container Guide

Getting Started Quickly:

1. Install Docker: Begin by downloading and installing Docker.

2. Set Up the Container: Use the following commands to pull the latest image and start the container:

docker pull hlohaus789/g4f
docker run -p 8080:8080 -p 1337:1337 -p 7900:7900 --shm-size="2g" -v ${PWD}/hardir:/app/hardir hlohaus789/g4f:latest

3. Access the Client:

   • To use the included client, navigate to: http://localhost:8080/chat/
   • Or set the API base for your client to: http://localhost:1337/v1

4. (Optional) Provider Login: If required, you can access the container's desktop here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret for provider login purposes.

Installation Guide for Windows (.exe)

To ensure the seamless operation of our application, please follow the instructions below. These steps are designed to guide you through the installation process on Windows operating systems.

Prerequisites

1. WebView2 Runtime: Our application requires the WebView2 Runtime to be installed on your system. If you do not have it installed, please download and install it from the Microsoft Developer Website. If you already have WebView2 Runtime installed but are encountering issues, navigate to Installed Windows Apps, select WebView2, and opt for the repair option.

Installation Steps

2. Download the Application: Visit our latest releases page and download the most recent version of the application, named g4f.webview.*.exe.
3. File Placement: Once downloaded, transfer the .exe file from your downloads folder to a directory of your choice on your system, and then execute it to run the app.

Post-Installation Adjustment

4. Firewall Configuration (Hotfix): Upon installation, it may be necessary to adjust your Windows Firewall settings to allow the application to operate correctly. To do this, access your Windows Firewall settings and allow the application.

By following these steps, you should be able to successfully install and run the application on your Windows system. If you encounter any issues during the installation process, please refer to our Issue Tracker or try to get contact over Discord for assistance.

Run the Webview UI on other Platfroms:

• /docs/guides/webview

Use your smartphone:

Run the Web UI on Your Smartphone:

• /docs/guides/phone

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

Full Documentation for Python API

• New Client API like the OpenAI Python library: /docs/client
• Legacy API with python modules: /docs/legacy

GUI Webserver

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: /docs/interference

Access with: http://localhost:1337/v1

Configuration

Cookies

You need cookies for BingCreateImages and the Gemini Provider. From Bing you need the "_U" cookie and from Gemini you need the "__Secure-1PSID" cookie. Sometimes you doesn't need the "__Secure-1PSID" cookie, but some other auth cookies. You can pass the cookies 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(".google.com", {
  "__Secure-1PSID": "cookie value"
})
...

.HAR File for OpenaiChat Provider

Generating a .HAR File

To utilize the OpenaiChat provider, a .har file is required from https://chat.openai.com/. Follow the steps below to create a valid .har file:

1. Navigate to https://chat.openai.com/ using your preferred web browser and log in with your credentials.
2. Access the Developer Tools in your browser. This can typically be done by right-clicking the page and selecting "Inspect," or by pressing F12 or Ctrl+Shift+I (Cmd+Option+I on a Mac).
3. With the Developer Tools open, switch to the "Network" tab.
4. Reload the website to capture the loading process within the Network tab.
5. Initiate an action in the chat which can be captured in the .har file.
6. Right-click any of the network activities listed and select "Save all as HAR with content" to export the .har file.

Storing the .HAR File

• Place the exported .har file in the ./hardir directory if you are using Docker. Alternatively, you can store it in any preferred location within your current working directory.

Note: Ensure that your .har file is stored securely, as it may contain sensitive information.

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	❌	✔️	✔️		❌
chatgpt.ai	g4f.Provider.ChatgptAi	❌	✔️	✔️		❌
liaobots.site	g4f.Provider.Liaobots	✔️	✔️	✔️		❌
chat.openai.com	g4f.Provider.OpenaiChat	✔️	❌	✔️		✔️
raycast.com	g4f.Provider.Raycast	✔️	✔️	✔️		✔️
beta.theb.ai	g4f.Provider.Theb	✔️	✔️	✔️		❌
you.com	g4f.Provider.You	✔️	✔️	✔️		❌

GPT-3.5

Website	Provider	GPT-3.5	GPT-4	Stream	Status	Auth
chat3.aiyunos.top	g4f.Provider.AItianhuSpace	✔️	❌	✔️		❌
chatforai.store	g4f.Provider.ChatForAi	✔️	❌	✔️		❌
chatgpt4online.org	g4f.Provider.Chatgpt4Online	✔️	❌	✔️		❌
chatgpt-free.cc	g4f.Provider.ChatgptNext	✔️	❌	✔️		❌
chatgptx.de	g4f.Provider.ChatgptX	✔️	❌	✔️		❌
flowgpt.com	g4f.Provider.FlowGpt	✔️	❌	✔️		❌
freegptsnav.aifree.site	g4f.Provider.FreeGpt	✔️	❌	✔️		❌
gpttalk.ru	g4f.Provider.GptTalkRu	✔️	❌	✔️		❌
koala.sh	g4f.Provider.Koala	✔️	❌	✔️		❌
app.myshell.ai	g4f.Provider.MyShell	✔️	❌	✔️		❌
perplexity.ai	g4f.Provider.PerplexityAi	✔️	❌	✔️		❌
poe.com	g4f.Provider.Poe	✔️	❌	✔️		✔️
talkai.info	g4f.Provider.TalkAi	✔️	❌	✔️		❌
chat.vercel.ai	g4f.Provider.Vercel	✔️	❌	✔️		❌
aitianhu.com	g4f.Provider.AItianhu	✔️	❌	✔️		❌
chatgpt.bestim.org	g4f.Provider.Bestim	✔️	❌	✔️		❌
chatbase.co	g4f.Provider.ChatBase	✔️	❌	✔️		❌
chatgptdemo.info	g4f.Provider.ChatgptDemo	✔️	❌	✔️		❌
chat.chatgptdemo.ai	g4f.Provider.ChatgptDemoAi	✔️	❌	✔️		❌
chatgptfree.ai	g4f.Provider.ChatgptFree	✔️	❌	❌		❌
chatgptlogin.ai	g4f.Provider.ChatgptLogin	✔️	❌	✔️		❌
chat.3211000.xyz	g4f.Provider.Chatxyz	✔️	❌	✔️		❌
gpt6.ai	g4f.Provider.Gpt6	✔️	❌	✔️		❌
gptchatly.com	g4f.Provider.GptChatly	✔️	❌	❌		❌
ai18.gptforlove.com	g4f.Provider.GptForLove	✔️	❌	✔️		❌
gptgo.ai	g4f.Provider.GptGo	✔️	❌	✔️		❌
gptgod.site	g4f.Provider.GptGod	✔️	❌	✔️		❌
onlinegpt.org	g4f.Provider.OnlineGpt	✔️	❌	✔️		❌

Other

Website	Provider	GPT-3.5	GPT-4	Stream	Status	Auth
openchat.team	g4f.Provider.Aura	❌	❌	✔️		❌
bard.google.com	g4f.Provider.Bard	❌	❌	❌		✔️
deepinfra.com	g4f.Provider.DeepInfra	❌	❌	✔️		❌
free.chatgpt.org.uk	g4f.Provider.FreeChatgpt	❌	❌	✔️		❌
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	❌	❌	✔️		❌
huggingface.co	g4f.Provider.HuggingFace	❌	❌	✔️		❌
llama2.ai	g4f.Provider.Llama2	❌	❌	✔️		❌
labs.perplexity.ai	g4f.Provider.PerplexityLabs	❌	❌	✔️		❌
pi.ai	g4f.Provider.Pi	❌	❌	✔️		❌
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	3+ Providers	llama.meta.com
CodeLlama-34b-Instruct-hf	Meta	2+ Providers	llama.meta.com
CodeLlama-70b-Instruct-hf	Meta	2+ Providers	llama.meta.com
Mixtral-8x7B-Instruct-v0.1	Huggingface	4+ Providers	huggingface.co
Mistral-7B-Instruct-v0.1	Huggingface	4+ 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	1+ Providers	anthropic.com
claude-3-opus	Anthropic	g4f.Provider.You	anthropic.com
claude-3-sonnet	Anthropic	g4f.Provider.You	anthropic.com
pi	Inflection	g4f.Provider.Pi	inflection.ai

🔗 Powered by gpt4free

🎁 Projects	⭐ Stars	📚 Forks	🛎 Issues	📬 Pull requests
gpt4free
gpt4free-ts
Free AI API's & Potential Providers List
ChatGPT-Clone
Ai agent
ChatGpt Discord Bot
chatGPT-discord-bot
Nyx-Bot (Discord)
LangChain gpt4free
ChatGpt Telegram Bot
ChatGpt Line Bot
Action Translate Readme
Langchain Document GPT
python-tgpt

🤝 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?

• Read: /docs/guides/create_provider

Guide: How can AI help me with writing code?

• Read: /docs/guides/help_me

🙌 Contributors

A list of all contributors is available here

• The Vercel.py file contains code from vercel-llm-api by @ading2210
• The har_file.py has input from xqdoo00o/ChatGPT-to-API
• The PerplexityLabs.py has input from nathanrchn/perplexityai
• The Gemini.py has input from dsdanielpark/Gemini-API

Having input implies that the AI's code generation utilized it as one of many sources.

©️ 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.

(🔼 Back to top)