Skip to main content

The official gpt4free repository | various collection of powerful language models

Project description

248433934-7886223b-c1d1-4260-82aa-da5741f303bb

xtekky%2Fgpt4free | Trendshift

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. (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

๐Ÿ› ๏ธ 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" -v ${PWD}/hardir:/app/hardir 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

Webview GUI

Open the GUI in a window of your OS. Runs on a local/static/ssl server and use a JavaScript API. Supports login into the OpenAI Chat, Image Upload and streamed Text Generation.

Supports all platforms, but only Linux tested.

  1. Install all requirements with:
pip install g4f[webview]
  1. Follow the OS specific steps here: pywebview installation

  2. Run the app with:

from g4f.gui.webview import run_webview
run_webview(debug=True)

or execute the following command:

python -m g4f.gui.webview -debug

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

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 capture 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 โŒ โœ”๏ธ โœ”๏ธ Unknown โŒ
chatgpt.ai g4f.Provider.ChatgptAi โŒ โœ”๏ธ โœ”๏ธ Active โŒ
liaobots.site g4f.Provider.Liaobots โœ”๏ธ โœ”๏ธ โœ”๏ธ Active โŒ
chat.openai.com g4f.Provider.OpenaiChat โœ”๏ธ โŒ โœ”๏ธ Unknown โœ”๏ธ
raycast.com g4f.Provider.Raycast โœ”๏ธ โœ”๏ธ โœ”๏ธ Unknown โœ”๏ธ
beta.theb.ai g4f.Provider.Theb โœ”๏ธ โœ”๏ธ โœ”๏ธ Unknown โŒ
you.com g4f.Provider.You โœ”๏ธ โœ”๏ธ โœ”๏ธ Unknown โŒ

GPT-3.5

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

Other

Website Provider GPT-3.5 GPT-4 Stream Status Auth
openchat.team g4f.Provider.Aura โŒ โŒ โœ”๏ธ Active โŒ
bard.google.com g4f.Provider.Bard โŒ โŒ โŒ Unknown โœ”๏ธ
deepinfra.com g4f.Provider.DeepInfra โŒ โŒ โœ”๏ธ Active โŒ
free.chatgpt.org.uk g4f.Provider.FreeChatgpt โŒ โŒ โœ”๏ธ Active โŒ
gemini.google.com g4f.Provider.Gemini โŒ โŒ โœ”๏ธ Active โœ”๏ธ
ai.google.dev g4f.Provider.GeminiPro โŒ โŒ โœ”๏ธ Active โœ”๏ธ
gemini-chatbot-sigma.vercel.app g4f.Provider.GeminiProChat โŒ โŒ โœ”๏ธ Unknown โŒ
huggingface.co g4f.Provider.HuggingChat โŒ โŒ โœ”๏ธ Active โŒ
huggingface.co g4f.Provider.HuggingFace โŒ โŒ โœ”๏ธ Active โŒ
llama2.ai g4f.Provider.Llama2 โŒ โŒ โœ”๏ธ Active โŒ
labs.perplexity.ai g4f.Provider.PerplexityLabs โŒ โŒ โœ”๏ธ Active โŒ
pi.ai g4f.Provider.Pi โŒ โŒ โœ”๏ธ Active โŒ
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 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 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
Ai agent Stars Forks Issues Pull Requests
ChatGpt Discord Bot 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

ยฉ๏ธ 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

Star History Chart

๐Ÿ“„ License


This project is licensed under GNU_GPL_v3.0.

(๐Ÿ”ผ Back to top)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

g4f-0.2.7.1.tar.gz (308.3 kB view hashes)

Uploaded Source

Built Distribution

g4f-0.2.7.1-py3-none-any.whl (371.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page