summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorHeiner Lohaus <hlohaus@users.noreply.github.com>2024-02-23 17:21:10 +0100
committerHeiner Lohaus <hlohaus@users.noreply.github.com>2024-02-23 17:21:10 +0100
commit7953560303ad82f13f3d4c910db1193da21b11d7 (patch)
treee88b25bcc756e02741ea1875fcf62ff9ba76b975 /README.md
parentFix isssue with stop in client (diff)
downloadgpt4free-7953560303ad82f13f3d4c910db1193da21b11d7.tar
gpt4free-7953560303ad82f13f3d4c910db1193da21b11d7.tar.gz
gpt4free-7953560303ad82f13f3d4c910db1193da21b11d7.tar.bz2
gpt4free-7953560303ad82f13f3d4c910db1193da21b11d7.tar.lz
gpt4free-7953560303ad82f13f3d4c910db1193da21b11d7.tar.xz
gpt4free-7953560303ad82f13f3d4c910db1193da21b11d7.tar.zst
gpt4free-7953560303ad82f13f3d4c910db1193da21b11d7.zip
Diffstat (limited to '')
-rw-r--r--README.md89
1 files changed, 48 insertions, 41 deletions
diff --git a/README.md b/README.md
index b8afa691..17aaaeb4 100644
--- a/README.md
+++ b/README.md
@@ -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` | ❌ | βœ”οΈ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
-| [free.chatgpt.org.uk](https://free.chatgpt.org.uk) | `g4f.Provider.FreeChatgpt` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [liaobots.site](https://liaobots.site) | `g4f.Provider.Liaobots` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
-| [chat.openai.com](https://chat.openai.com) | `g4f.Provider.OpenaiChat` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | βœ”οΈ |
+| [chat.openai.com](https://chat.openai.com) | `g4f.Provider.OpenaiChat` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Active-brightgreen) | βœ”οΈ |
| [raycast.com](https://raycast.com) | `g4f.Provider.Raycast` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | βœ”οΈ |
-| [beta.theb.ai](https://beta.theb.ai) | `g4f.Provider.Theb` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
+| [you.com](https://you.com) | `g4f.Provider.You` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
| [chat.geekgpt.org](https://chat.geekgpt.org) | `g4f.Provider.GeekGpt` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Inactive](https://img.shields.io/badge/Inactive-red) | ❌ |
### GPT-3.5
@@ -242,14 +246,13 @@ set G4F_PROXY=http://host:port
| [chat3.aiyunos.top](https://chat3.aiyunos.top/) | `g4f.Provider.AItianhuSpace` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [aichatonline.org](https://aichatonline.org) | `g4f.Provider.AiChatOnline` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [openchat.team](https://openchat.team) | `g4f.Provider.Aura` | βœ”οΈ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
-| [chatbase.co](https://www.chatbase.co) | `g4f.Provider.ChatBase` | βœ”οΈ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
+| [chatbase.co](https://www.chatbase.co) | `g4f.Provider.ChatBase` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [chatforai.store](https://chatforai.store) | `g4f.Provider.ChatForAi` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [chatgpt.ai](https://chatgpt.ai) | `g4f.Provider.ChatgptAi` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [chat.chatgptdemo.net](https://chat.chatgptdemo.net) | `g4f.Provider.ChatgptDemo` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [chatgpt-free.cc](https://www.chatgpt-free.cc) | `g4f.Provider.ChatgptNext` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [chat.3211000.xyz](https://chat.3211000.xyz) | `g4f.Provider.Chatxyz` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [gptalk.net](https://gptalk.net) | `g4f.Provider.GPTalk` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
-| [geminiprochat.com](https://geminiprochat.com) | `g4f.Provider.GeminiProChat` | βœ”οΈ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
| [gpt6.ai](https://gpt6.ai) | `g4f.Provider.Gpt6` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [gptchatly.com](https://gptchatly.com) | `g4f.Provider.GptChatly` | βœ”οΈ | ❌ | ❌ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [ai18.gptforlove.com](https://ai18.gptforlove.com) | `g4f.Provider.GptForLove` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
@@ -261,7 +264,6 @@ set G4F_PROXY=http://host:port
| [perplexity.ai](https://www.perplexity.ai) | `g4f.Provider.PerplexityAi` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [poe.com](https://poe.com) | `g4f.Provider.Poe` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | βœ”οΈ |
| [talkai.info](https://talkai.info) | `g4f.Provider.TalkAi` | βœ”οΈ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
-| [you.com](https://you.com) | `g4f.Provider.You` | βœ”οΈ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
| [aitianhu.com](https://www.aitianhu.com) | `g4f.Provider.AItianhu` | βœ”οΈ | ❌ | βœ”οΈ | ![Inactive](https://img.shields.io/badge/Inactive-red) | ❌ |
| [e.aiask.me](https://e.aiask.me) | `g4f.Provider.AiAsk` | βœ”οΈ | ❌ | βœ”οΈ | ![Inactive](https://img.shields.io/badge/Inactive-red) | ❌ |
| [chatgpt.bestim.org](https://chatgpt.bestim.org) | `g4f.Provider.Bestim` | βœ”οΈ | ❌ | βœ”οΈ | ![Inactive](https://img.shields.io/badge/Inactive-red) | ❌ |
@@ -284,12 +286,16 @@ set G4F_PROXY=http://host:port
| ------ | ------- | ------- | ----- | ------ | ------ | ---- |
| [bard.google.com](https://bard.google.com) | `g4f.Provider.Bard` | ❌ | ❌ | ❌ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | βœ”οΈ |
| [deepinfra.com](https://deepinfra.com) | `g4f.Provider.DeepInfra` | ❌ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
-| [gemini.google.com](https://gemini.google.com) | `g4f.Provider.Gemini` | ❌ | ❌ | ❌ | ![Active](https://img.shields.io/badge/Active-brightgreen) | βœ”οΈ |
-| [huggingface.co](https://huggingface.co/chat) | `g4f.Provider.HuggingChat` | ❌ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
+| [gemini.google.com](https://gemini.google.com) | `g4f.Provider.Gemini` | ❌ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | βœ”οΈ |
+| [ai.google.dev](https://ai.google.dev) | `g4f.Provider.GeminiPro` | ❌ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Active-brightgreen) | ❌ |
+| [gemini-chatbot-sigma.vercel.app](https://gemini-chatbot-sigma.vercel.app) | `g4f.Provider.GeminiProChat` | βœ”οΈ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
+| [huggingface.co](https://huggingface.co/chat) | `g4f.Provider.HuggingChat` | ❌ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [llama2.ai](https://www.llama2.ai) | `g4f.Provider.Llama2` | ❌ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
| [labs.perplexity.ai](https://labs.perplexity.ai) | `g4f.Provider.PerplexityLabs` | ❌ | ❌ | βœ”οΈ | ![Active](https://img.shields.io/badge/Active-brightgreen) | ❌ |
-| [phind.com](https://www.phind.com) | `g4f.Provider.Phind` | ❌ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
-| [pi.ai](https://pi.ai/talk) | `g4f.Provider.Pi` | ❌ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
+| [phind.com](https://www.phind.com) | `g4f.Provider.Phind` | ❌ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Active-brightgreen) | ❌ |
+| [pi.ai](https://pi.ai/talk) | `g4f.Provider.Pi` | ❌ | ❌ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Active-brightgreen) | ❌ |
+| [beta.theb.ai](https://beta.theb.ai) | `g4f.Provider.Theb` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
+| [free.chatgpt.org.uk](https://free.chatgpt.org.uk) | `g4f.Provider.FreeChatgpt` | βœ”οΈ | βœ”οΈ | βœ”οΈ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | ❌ |
| [theb.ai](https://theb.ai) | `g4f.Provider.ThebApi` | ❌ | ❌ | ❌ | ![Unknown](https://img.shields.io/badge/Unknown-grey) | βœ”οΈ |
| [open-assistant.io](https://open-assistant.io/chat) | `g4f.Provider.OpenAssistant` | ❌ | ❌ | βœ”οΈ | ![Inactive](https://img.shields.io/badge/Inactive-red) | βœ”οΈ |
@@ -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/) |