diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 89 |
1 files changed, 48 insertions, 41 deletions
@@ -19,10 +19,10 @@ pip install -U g4f docker pull hlohaus789/g4f ``` -## π What's New +## π What's New π +- How do I use my smartphoneπ± to run g4f? [/docs/guides/phone](/docs/guides/phone.md) - Join our Telegram Channel: [t.me/g4f_channel](https://telegram.me/g4f_channel) - Join our Discord Group: [discord.gg/XfybzPXPH5](https://discord.gg/XfybzPXPH5) -- Explore the g4f Documentation (unfinished): [g4f.mintlify.app](https://g4f.mintlify.app) | Contribute to the docs via: [github.com/xtekky/gpt4free-docs](https://github.com/xtekky/gpt4free-docs) ## 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 ; ) @@ -34,13 +34,13 @@ You can always leave some feedback here: https://forms.gle/FeWV9RLEedfdkmFN6 As per the survey, here is a list of improvements to come - [x] update the repository to include the new openai library syntax (ex: `Openai()` class) | completed, use `g4f.client.Client` - [ ] golang implementation -- [ ] Improve Documentation (on g4f.mintlify.app) & Do video tutorials -- [ ] Improve the provider status list & updates +- [ ] π§ Improve Documentation (in /docs & Guides, Howtos, & Do video tutorials +- [x] 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 +- [ ] π§ improve compatibility and error handling ## π Table of Contents @@ -49,22 +49,17 @@ As per the survey, here is a list of improvements to come - [π οΈ Getting Started](#-getting-started) + [Docker container](#docker-container) - [Quick start](#quick-start) - + [Use python package](#use-python-package) + + [Use python](#use-python) - [Prerequisites](#prerequisites) - - [Install using pypi](#install-using-pypi) - + [Docker for Developers](#docker-for-developers) + - [Install using PyPI package:](#install-using-pypi-package-) + - [Install from source:](#install-from-source-) + - [Install using Docker:](#install-using-docker-) - [π‘ Usage](#-usage) * [The Web UI](#the-web-ui) - * [The `g4f` Package](#the-g4f-package) - + [ChatCompletion](#chatcompletion) - - [Completion](#completion) - - [Providers](#providers) - - [Using Browser](#using-browser) - - [Async Support](#async-support) - - [Proxy and Timeout Support](#proxy-and-timeout-support) - * [Interference openai-proxy API](#interference-openai-proxy-api-use-with-openai-python-package-) - + [Run interference API from PyPi package](#run-interference-api-from-pypi-package) - + [Run interference API from repo](#run-interference-api-from-repo) + * [Text Generation](#text-generation) + * [Image Generation](#text-generation) + * [Interference API](#interference-api) + * [Configuration](#configuration) - [π Providers and Models](#-providers-and-models) * [GPT-4](#gpt-4) * [GPT-3.5](#gpt-35) @@ -96,6 +91,11 @@ docker run -p 8080:8080 -p 1337:1337 -p 7900:7900 --shm-size="2g" hlohaus789/g4f or set the api base in your client to: [http://localhost:1337/v1](http://localhost:1337/v1) 4. (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: +- [/docs/guides/phone](/docs/guides/phone.md) + #### Use python ##### Prerequisites: @@ -109,18 +109,19 @@ or set the api base in your client to: [http://localhost:1337/v1](http://localho pip install -U g4f[all] ``` -Or use partial requirements. - -See: [/docs/requirements](/docs/requirements.md) +How do I install only parts or do disable parts? +Use partial requirements: [/docs/requirements](/docs/requirements.md) -##### Install from source using git: +##### Install from source: -See: [/docs/git](/docs/git.md) +How do I load the project using git and installing the project requirements? +Read this tutorial and follow it step by step: [/docs/git](/docs/git.md) -##### Install using Docker for Developers: +##### Install using Docker: - See: [/docs/docker](/docs/docker.md) +How do I build and run composer image from source? +Use docker-compose: [/docs/docker](/docs/docker.md) ## π‘ Usage @@ -139,6 +140,10 @@ response = client.chat.completions.create( print(response.choices[0].message.content) ``` +``` +Hello! How can I assist you today? +``` + #### Image Generation ```python @@ -159,8 +164,8 @@ image_url = response.data[0].url **See also:** -- Documentation for the new Client: [/docs/client](/docs/client.md) -- Documentation for the leagcy API: [docs/leagcy](/docs/leagcy.md) +- Documentation for the new Client API: [/docs/client](/docs/client.md) +- Documentation for the leagcy API: [/docs/leagcy](/docs/leagcy.md) #### Web UI @@ -228,11 +233,10 @@ set G4F_PROXY=http://host:port | Website | Provider | GPT-3.5 | GPT-4 | Stream | Status | Auth | | ------ | ------- | ------- | ----- | ------ | ------ | ---- | | [bing.com](https://bing.com/chat) | `g4f.Provider.Bing` | β | βοΈ | βοΈ |  | β | -| [free.chatgpt.org.uk](https://free.chatgpt.org.uk) | `g4f.Provider.FreeChatgpt` | βοΈ | βοΈ | βοΈ |  | β | | [liaobots.site](https://liaobots.site) | `g4f.Provider.Liaobots` | βοΈ | βοΈ | βοΈ |  | β | -| [chat.openai.com](https://chat.openai.com) | `g4f.Provider.OpenaiChat` | βοΈ | βοΈ | βοΈ |  | βοΈ | +| [chat.openai.com](https://chat.openai.com) | `g4f.Provider.OpenaiChat` | βοΈ | βοΈ | βοΈ |  | βοΈ | | [raycast.com](https://raycast.com) | `g4f.Provider.Raycast` | βοΈ | βοΈ | βοΈ |  | βοΈ | -| [beta.theb.ai](https://beta.theb.ai) | `g4f.Provider.Theb` | βοΈ | βοΈ | βοΈ |  | β | +| [you.com](https://you.com) | `g4f.Provider.You` | βοΈ | βοΈ | βοΈ |  | β | | [chat.geekgpt.org](https://chat.geekgpt.org) | `g4f.Provider.GeekGpt` | βοΈ | βοΈ | βοΈ |  | β | ### GPT-3.5 @@ -242,14 +246,13 @@ set G4F_PROXY=http://host:port | [chat3.aiyunos.top](https://chat3.aiyunos.top/) | `g4f.Provider.AItianhuSpace` | βοΈ | β | βοΈ |  | β | | [aichatonline.org](https://aichatonline.org) | `g4f.Provider.AiChatOnline` | βοΈ | β | βοΈ |  | β | | [openchat.team](https://openchat.team) | `g4f.Provider.Aura` | βοΈ | β | βοΈ |  | β | -| [chatbase.co](https://www.chatbase.co) | `g4f.Provider.ChatBase` | βοΈ | β | βοΈ |  | β | +| [chatbase.co](https://www.chatbase.co) | `g4f.Provider.ChatBase` | βοΈ | β | βοΈ |  | β | | [chatforai.store](https://chatforai.store) | `g4f.Provider.ChatForAi` | βοΈ | β | βοΈ |  | β | | [chatgpt.ai](https://chatgpt.ai) | `g4f.Provider.ChatgptAi` | βοΈ | β | βοΈ |  | β | | [chat.chatgptdemo.net](https://chat.chatgptdemo.net) | `g4f.Provider.ChatgptDemo` | βοΈ | β | βοΈ |  | β | | [chatgpt-free.cc](https://www.chatgpt-free.cc) | `g4f.Provider.ChatgptNext` | βοΈ | β | βοΈ |  | β | | [chat.3211000.xyz](https://chat.3211000.xyz) | `g4f.Provider.Chatxyz` | βοΈ | β | βοΈ |  | β | | [gptalk.net](https://gptalk.net) | `g4f.Provider.GPTalk` | βοΈ | β | βοΈ |  | β | -| [geminiprochat.com](https://geminiprochat.com) | `g4f.Provider.GeminiProChat` | βοΈ | β | βοΈ |  | β | | [gpt6.ai](https://gpt6.ai) | `g4f.Provider.Gpt6` | βοΈ | β | βοΈ |  | β | | [gptchatly.com](https://gptchatly.com) | `g4f.Provider.GptChatly` | βοΈ | β | β |  | β | | [ai18.gptforlove.com](https://ai18.gptforlove.com) | `g4f.Provider.GptForLove` | βοΈ | β | βοΈ |  | β | @@ -261,7 +264,6 @@ set G4F_PROXY=http://host:port | [perplexity.ai](https://www.perplexity.ai) | `g4f.Provider.PerplexityAi` | βοΈ | β | βοΈ |  | β | | [poe.com](https://poe.com) | `g4f.Provider.Poe` | βοΈ | β | βοΈ |  | βοΈ | | [talkai.info](https://talkai.info) | `g4f.Provider.TalkAi` | βοΈ | β | βοΈ |  | β | -| [you.com](https://you.com) | `g4f.Provider.You` | βοΈ | β | βοΈ |  | β | | [aitianhu.com](https://www.aitianhu.com) | `g4f.Provider.AItianhu` | βοΈ | β | βοΈ |  | β | | [e.aiask.me](https://e.aiask.me) | `g4f.Provider.AiAsk` | βοΈ | β | βοΈ |  | β | | [chatgpt.bestim.org](https://chatgpt.bestim.org) | `g4f.Provider.Bestim` | βοΈ | β | βοΈ |  | β | @@ -284,12 +286,16 @@ set G4F_PROXY=http://host:port | ------ | ------- | ------- | ----- | ------ | ------ | ---- | | [bard.google.com](https://bard.google.com) | `g4f.Provider.Bard` | β | β | β |  | βοΈ | | [deepinfra.com](https://deepinfra.com) | `g4f.Provider.DeepInfra` | β | β | βοΈ |  | β | -| [gemini.google.com](https://gemini.google.com) | `g4f.Provider.Gemini` | β | β | β |  | βοΈ | -| [huggingface.co](https://huggingface.co/chat) | `g4f.Provider.HuggingChat` | β | β | βοΈ |  | β | +| [gemini.google.com](https://gemini.google.com) | `g4f.Provider.Gemini` | β | β | βοΈ |  | βοΈ | +| [ai.google.dev](https://ai.google.dev) | `g4f.Provider.GeminiPro` | β | β | βοΈ |  | β | +| [gemini-chatbot-sigma.vercel.app](https://gemini-chatbot-sigma.vercel.app) | `g4f.Provider.GeminiProChat` | βοΈ | β | βοΈ |  | β | +| [huggingface.co](https://huggingface.co/chat) | `g4f.Provider.HuggingChat` | β | β | βοΈ |  | β | | [llama2.ai](https://www.llama2.ai) | `g4f.Provider.Llama2` | β | β | βοΈ |  | β | | [labs.perplexity.ai](https://labs.perplexity.ai) | `g4f.Provider.PerplexityLabs` | β | β | βοΈ |  | β | -| [phind.com](https://www.phind.com) | `g4f.Provider.Phind` | β | β | βοΈ |  | β | -| [pi.ai](https://pi.ai/talk) | `g4f.Provider.Pi` | β | β | βοΈ |  | β | +| [phind.com](https://www.phind.com) | `g4f.Provider.Phind` | β | β | βοΈ |  | β | +| [pi.ai](https://pi.ai/talk) | `g4f.Provider.Pi` | β | β | βοΈ |  | β | +| [beta.theb.ai](https://beta.theb.ai) | `g4f.Provider.Theb` | βοΈ | βοΈ | βοΈ |  | β | +| [free.chatgpt.org.uk](https://free.chatgpt.org.uk) | `g4f.Provider.FreeChatgpt` | βοΈ | βοΈ | βοΈ |  | β | | [theb.ai](https://theb.ai) | `g4f.Provider.ThebApi` | β | β | β |  | βοΈ | | [open-assistant.io](https://open-assistant.io/chat) | `g4f.Provider.OpenAssistant` | β | β | βοΈ |  | βοΈ | @@ -300,10 +306,11 @@ set G4F_PROXY=http://host:port | gpt-3.5-turbo | OpenAI | 5+ Providers | [openai.com](https://openai.com/) | | gpt-4 | OpenAI | 2+ Providers | [openai.com](https://openai.com/) | | gpt-4-turbo | OpenAI | g4f.Provider.Bing | [openai.com](https://openai.com/) | -| Llama-2-7b-chat-hf | Huggingface | 2+ Providers | [huggingface.co](https://huggingface.co/) | -| Llama-2-13b-chat-hf | Huggingface | 2+ Providers | [huggingface.co](https://huggingface.co/) | -| Llama-2-70b-chat-hf | Huggingface | 4+ Providers | [huggingface.co](https://huggingface.co/) | -| CodeLlama-34b-Instruct-hf | Huggingface | 3+ Providers | [huggingface.co](https://huggingface.co/) | +| Llama-2-7b-chat-hf | Meta | 2+ Providers | [llama.meta.com](https://llama.meta.com/) | +| Llama-2-13b-chat-hf | Meta | 2+ Providers | [llama.meta.com](https://llama.meta.com/) | +| Llama-2-70b-chat-hf | Meta | 4+ Providers | [llama.meta.com](https://llama.meta.com/) | +| CodeLlama-34b-Instruct-hf | Meta | 3+ Providers | [llama.meta.com](https://llama.meta.com/) | +| CodeLlama-70b-Instruct-hf | Meta | g4f.Provider.DeepInfra | [llama.meta.com](https://llama.meta.com/) | | Mixtral-8x7B-Instruct-v0.1 | Huggingface | 3+ Providers | [huggingface.co](https://huggingface.co/) | | Mistral-7B-Instruct-v0.1 | Huggingface | 3+ Providers | [huggingface.co](https://huggingface.co/) | | dolphin-2.6-mixtral-8x7b | Huggingface | g4f.Provider.DeepInfra | [huggingface.co](https://huggingface.co/) | |