2023-08-07 14:18:40 +03:00
2023-06-24 04:47:00 +03:00
2023-08-20 22:12:13 +03:00
By using this repository or any code related to it, you agree to the [legal notice ](./LEGAL_NOTICE.md ). The author is not responsible for any copies, forks, reuploads 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.
2023-06-24 04:47:00 +03:00
2023-08-20 22:12:13 +03:00
This (quite censored) New Version of gpt4free, was just released so it may contain bugs. Please open an issue or contribute a PR when encountering one.
P.S: Docker is for now not available but I would be happy if someone contributes a PR. The g4f GUI will be uploaded soon enough.
2023-06-24 04:47:00 +03:00
2023-07-17 03:12:49 +03:00
### New
- pypi package:
```
2023-07-18 02:16:39 +03:00
pip install -U g4f
2023-07-17 03:12:49 +03:00
```
2023-06-24 04:47:00 +03:00
## Table of Contents:
- [Getting Started ](#getting-started )
2023-07-12 00:34:06 +03:00
+ [Prerequisites ](#prerequisites )
+ [Setting up the project ](#setting-up-the-project )
2023-06-24 04:47:00 +03:00
- [Usage ](#usage )
2023-07-12 00:34:06 +03:00
* [The `g4f` Package ](#the-g4f-package )
* [interference openai-proxy api ](#interference-openai-proxy-api-use-with-openai-python-package )
2023-06-24 04:47:00 +03:00
- [Models ](#models )
2023-07-12 00:34:06 +03:00
* [gpt-3.5 / gpt-4 ](#gpt-35--gpt-4 )
2023-06-24 04:47:00 +03:00
* [Other Models ](#other-models )
- [Related gpt4free projects ](#related-gpt4free-projects )
- [Contribute ](#contribute )
- [ChatGPT clone ](#chatgpt-clone )
2023-07-12 00:34:06 +03:00
- [Copyright ](#copyright )
- [Copyright Notice ](#copyright-notice )
2023-06-24 04:47:00 +03:00
- [Star History ](#star-history )
## Getting Started
#### Prerequisites:
1. [Download and install Python ](https://www.python.org/downloads/ ) (Version 3.x is recommended).
#### Setting up the project:
2023-07-17 03:14:10 +03:00
##### Install using pypi
```
2023-07-18 02:16:39 +03:00
pip install -U g4f
2023-07-17 03:14:10 +03:00
```
##### or
2023-06-24 04:47:00 +03:00
1. Clone the GitHub repository:
```
2023-06-24 23:39:20 +03:00
git clone https://github.com/xtekky/gpt4free.git
2023-06-24 04:47:00 +03:00
```
2. Navigate to the project directory:
```
2023-06-24 23:39:20 +03:00
cd gpt4free
2023-06-24 04:47:00 +03:00
```
3. (Recommended) Create a virtual environment to manage Python packages for your project:
```
python3 -m venv venv
```
4. Activate the virtual environment:
- On Windows:
```
.\venv\Scripts\activate
```
- On macOS and Linux:
```
source venv/bin/activate
```
5. Install the required Python packages from `requirements.txt` :
```
pip install -r requirements.txt
```
2023-05-07 01:23:48 +03:00
2023-06-24 04:47:00 +03:00
6. Create a `test.py` file in the root folder and start using the repo, further Instructions are below
```py
import g4f
2023-06-09 03:20:02 +03:00
2023-06-24 04:47:00 +03:00
...
```
2023-05-08 01:50:35 +03:00
2023-06-24 04:47:00 +03:00
## Usage
2023-05-02 21:20:02 +03:00
2023-06-24 04:47:00 +03:00
### The `g4f` Package
```py
import g4f
2023-05-02 21:20:02 +03:00
2023-05-01 23:21:45 +03:00
2023-08-18 11:33:43 +03:00
print(g4f.Provider.Ails.params) # supported args
2023-05-01 23:21:45 +03:00
2023-06-24 04:47:00 +03:00
# Automatic selection of provider
2023-05-01 23:21:45 +03:00
2023-06-24 04:47:00 +03:00
# streamed completion
2023-07-28 13:07:17 +03:00
response = g4f.ChatCompletion.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "Hello world"}],
stream=True,
)
2023-05-01 23:21:45 +03:00
2023-06-24 04:47:00 +03:00
for message in response:
2023-07-28 13:07:17 +03:00
print(message, flush=True, end='')
2023-05-04 14:42:37 +03:00
2023-06-24 04:47:00 +03:00
# normal response
2023-07-28 13:07:17 +03:00
response = g4f.ChatCompletion.create(
model=g4f.models.gpt_4,
messages=[{"role": "user", "content": "hi"}],
) # alterative model setting
2023-05-01 23:21:45 +03:00
2023-06-24 04:47:00 +03:00
print(response)
2023-05-01 23:21:45 +03:00
2023-05-02 11:40:12 +03:00
2023-06-24 04:47:00 +03:00
# Set with provider
2023-07-28 13:07:17 +03:00
response = g4f.ChatCompletion.create(
model="gpt-3.5-turbo",
2023-08-18 11:33:43 +03:00
provider=g4f.Provider.DeepAi,
2023-07-28 13:07:17 +03:00
messages=[{"role": "user", "content": "Hello world"}],
stream=True,
)
2023-05-02 11:44:36 +03:00
2023-06-24 04:47:00 +03:00
for message in response:
print(message)
```
2023-05-02 11:44:36 +03:00
2023-06-24 04:47:00 +03:00
providers:
```py
2023-08-18 11:33:43 +03:00
from g4f.Provider import (
2023-07-28 13:07:17 +03:00
Acytoo,
2023-06-24 04:47:00 +03:00
Aichat,
2023-07-28 13:07:17 +03:00
Ails,
AiService,
AItianhu,
2023-06-24 04:47:00 +03:00
Bard,
2023-07-28 13:07:17 +03:00
Bing,
ChatgptAi,
2023-06-24 04:47:00 +03:00
ChatgptLogin,
DeepAi,
2023-07-28 13:07:17 +03:00
GetGpt
2023-06-24 04:47:00 +03:00
)
2023-07-28 13:07:17 +03:00
2023-06-24 04:47:00 +03:00
# usage:
response = g4f.ChatCompletion.create(..., provider=ProviderName)
```
2023-05-01 23:21:45 +03:00
2023-06-24 04:47:00 +03:00
### interference openai-proxy api (use with openai python package)
2023-05-01 01:18:57 +03:00
2023-08-17 16:28:49 +03:00
get requirements:
```sh
pip install -r interference/requirements.txt
```
2023-06-24 04:47:00 +03:00
run server:
```sh
python3 -m interference.app
```
2023-05-01 01:18:57 +03:00
2023-06-24 04:47:00 +03:00
```py
import openai
2023-07-28 13:07:17 +03:00
openai.api_key = ""
openai.api_base = "http://localhost:1337"
2023-06-24 04:47:00 +03:00
2023-07-28 13:07:17 +03:00
def main():
chat_completion = openai.ChatCompletion.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "write a poem about a tree"}],
stream=True,
)
2023-06-24 04:47:00 +03:00
2023-07-28 13:07:17 +03:00
if isinstance(chat_completion, dict):
# not stream
print(chat_completion.choices[0].message.content)
else:
# stream
for token in chat_completion:
content = token["choices"][0]["delta"].get("content")
if content != None:
print(content, end="", flush=True)
if __name__ == "__main__":
main()
2023-06-24 04:47:00 +03:00
```
2023-08-14 02:06:19 +03:00
## Models
2023-06-24 04:47:00 +03:00
### gpt-3.5 / gpt-4
2023-08-17 16:01:59 +03:00
| Website| Provider| gpt-3.5 | gpt-4 | Streaming | Status | Auth |
| ------ | ------- | ------- | ----- | --------- | ------ | ---- |
2023-08-24 22:32:22 +03:00
| [chat.acytoo.com ](https://chat.acytoo.com/ ) | g4f.provider.Acytoo | ✔️ | ❌ | ❌ |  | ❌ |
| [chat-gpt.org ](https://chat-gpt.org/chat ) | g4f.provider.Aichat | ✔️ | ❌ | ❌ |  | ❌ |
| [ai.ls ](https://ai.ls ) | g4f.provider.Ails | ✔️ | ❌ | ✔️ |  | ❌ |
| [bard.google.com ](https://bard.google.com ) | g4f.provider.Bard | ❌ | ❌ | ❌ |  | ✔️ |
| [chatgpt.ai ](https://chatgpt.ai/gpt-4/ ) | g4f.provider.ChatgptAi | ❌ | ✔️ | ❌ |  | ❌ |
| [opchatgpts.net ](https://opchatgpts.net ) | g4f.provider.ChatgptLogin | ✔️ | ❌ | ❌ |  | ❌ |
| [deepai.org ](https://deepai.org ) | g4f.provider.DeepAi | ✔️ | ❌ | ✔️ |  | ❌ |
| [free.easychat.work ](https://free.easychat.work ) | g4f.provider.EasyChat | ✔️ | ❌ | ✔️ |  | ❌ |
| [next.eqing.tech ](https://next.eqing.tech/ ) | g4f.provider.Equing | ✔️ | ❌ | ✔️ |  | ❌ |
| [chat.getgpt.world ](https://chat.getgpt.world/ ) | g4f.provider.GetGpt | ✔️ | ❌ | ✔️ |  | ❌ |
| [gpt-gm.h2o.ai ](https://gpt-gm.h2o.ai ) | g4f.provider.H2o | ❌ | ❌ | ✔️ |  | ❌ |
| [opchatgpts.net ](https://opchatgpts.net ) | g4f.provider.Opchatgpts | ✔️ | ❌ | ❌ |  | ❌ |
| [raycast.com ](https://raycast.com ) | g4f.provider.Raycast | ✔️ | ✔️ | ✔️ |  | ✔️ |
| [theb.ai ](https://theb.ai ) | g4f.provider.Theb | ✔️ | ❌ | ✔️ |  | ✔️ |
| [play.vercel.ai ](https://play.vercel.ai ) | g4f.provider.Vercel | ✔️ | ❌ | ❌ |  | ❌ |
| [wewordle.org ](https://wewordle.org/ ) | g4f.provider.Wewordle | ✔️ | ❌ | ❌ |  | ❌ |
| [you.com ](https://you.com ) | g4f.provider.You | ✔️ | ❌ | ❌ |  | ❌ |
| [chat9.yqcloud.top ](https://chat9.yqcloud.top/ ) | g4f.provider.Yqcloud | ✔️ | ❌ | ❌ |  | ❌ |
| [www.aitianhu.com ](https://www.aitianhu.com/ ) | g4f.provider.AItianhu | ✔️ | ❌ | ❌ |  | ❌ |
| [aiservice.vercel.app ](https://aiservice.vercel.app/ ) | g4f.provider.AiService | ✔️ | ❌ | ❌ |  | ❌ |
| [bing.com ](https://bing.com/chat ) | g4f.provider.Bing | ❌ | ✔️ | ❌ |  | ❌ |
| [chat.dfehub.com ](https://chat.dfehub.com/ ) | g4f.provider.DfeHub | ✔️ | ❌ | ✔️ |  | ❌ |
| [chat9.fastgpt.me ](https://chat9.fastgpt.me/ ) | g4f.provider.FastGpt | ✔️ | ❌ | ✔️ |  | ❌ |
| [forefront.com ](https://forefront.com ) | g4f.provider.Forefront | ✔️ | ❌ | ✔️ |  | ❌ |
| [liaobots.com ](https://liaobots.com ) | g4f.provider.Liaobots | ✔️ | ✔️ | ✔️ |  | ✔️ |
| [supertest.lockchat.app ](http://supertest.lockchat.app ) | g4f.provider.Lockchat | ✔️ | ✔️ | ✔️ |  | ❌ |
| [p5.v50.ltd ](https://p5.v50.ltd ) | g4f.provider.V50 | ✔️ | ❌ | ❌ |  | ❌ |
2023-06-24 04:47:00 +03:00
### Other Models
2023-07-28 13:07:17 +03:00
| Model | Base Provider | Provider | Website |
| --------------------------------------- | ------------- | ------------------- | ------------------------------------------- |
2023-08-18 11:33:43 +03:00
| palm | Google | g4f.Provider.Bard | [bard.google.com ](https://bard.google.com/ ) |
| h2ogpt-gm-oasst1-en-2048-falcon-7b-v3 | Huggingface | g4f.Provider.H2o | [www.h2o.ai ](https://www.h2o.ai/ ) |
| h2ogpt-gm-oasst1-en-2048-falcon-40b-v1 | Huggingface | g4f.Provider.H2o | [www.h2o.ai ](https://www.h2o.ai/ ) |
| h2ogpt-gm-oasst1-en-2048-open-llama-13b | Huggingface | g4f.Provider.H2o | [www.h2o.ai ](https://www.h2o.ai/ ) |
| claude-instant-v1 | Anthropic | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| claude-v1 | Anthropic | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| claude-v2 | Anthropic | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| command-light-nightly | Cohere | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| command-nightly | Cohere | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| gpt-neox-20b | Huggingface | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| oasst-sft-1-pythia-12b | Huggingface | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| oasst-sft-4-pythia-12b-epoch-3.5 | Huggingface | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| santacoder | Huggingface | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| bloom | Huggingface | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| flan-t5-xxl | Huggingface | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| code-davinci-002 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| gpt-3.5-turbo-16k | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| gpt-3.5-turbo-16k-0613 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| gpt-4-0613 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| text-ada-001 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| text-babbage-001 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| text-curie-001 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| text-davinci-002 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| text-davinci-003 | OpenAI | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| llama13b-v2-chat | Replicate | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
| llama7b-v2-chat | Replicate | g4f.Provider.Vercel | [sdk.vercel.ai ](https://sdk.vercel.ai/ ) |
2023-06-24 04:47:00 +03:00
## Related gpt4free projects
2023-05-01 01:18:57 +03:00
2023-05-01 01:29:27 +03:00
< table >
< thead align = "center" >
< tr border: none ; >
< td > < b > 🎁 Projects< / b > < / td >
< td > < b > ⭐ Stars< / b > < / td >
< td > < b > 📚 Forks< / b > < / td >
< td > < b > 🛎 Issues< / b > < / td >
< td > < b > 📬 Pull requests< / b > < / td >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a href = "https://github.com/xtekky/gpt4free" > < b > gpt4free< / b > < / a > < / td >
< td > < a href = "https://github.com/xtekky/gpt4free/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/xtekky/gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xtekky/gpt4free/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/xtekky/gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xtekky/gpt4free/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/xtekky/gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xtekky/gpt4free/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/xtekky/gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< / tr >
2023-05-04 17:16:38 +03:00
< tr >
< td > < a href = "https://github.com/xiangsx/gpt4free-ts" > < b > gpt4free-ts< / b > < / a > < / td >
< td > < a href = "https://github.com/xiangsx/gpt4free-ts/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/xiangsx/gpt4free-ts?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xiangsx/gpt4free-ts/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/xiangsx/gpt4free-ts?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xiangsx/gpt4free-ts/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/xiangsx/gpt4free-ts?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xiangsx/gpt4free-ts/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/xiangsx/gpt4free-ts?style=flat-square&labelColor=343b41" / > < / a > < / td >
< / tr >
2023-05-01 01:29:27 +03:00
< tr >
< td > < a href = "https://github.com/xtekky/chatgpt-clone" > < b > ChatGPT-Clone< / b > < / a > < / td >
< td > < a href = "https://github.com/xtekky/chatgpt-clone/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/xtekky/chatgpt-clone?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xtekky/chatgpt-clone/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/xtekky/chatgpt-clone?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xtekky/chatgpt-clone/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/xtekky/chatgpt-clone?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/xtekky/chatgpt-clone/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/xtekky/chatgpt-clone?style=flat-square&labelColor=343b41" / > < / a > < / td >
< / tr >
2023-05-01 03:35:00 +03:00
< tr >
2023-05-01 18:27:57 +03:00
< td > < a href = "https://github.com/mishalhossin/Discord-Chatbot-Gpt4Free" > < b > ChatGpt Discord Bot< / b > < / a > < / td >
< td > < a href = "https://github.com/mishalhossin/Discord-Chatbot-Gpt4Free/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/mishalhossin/Discord-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/mishalhossin/Discord-Chatbot-Gpt4Free/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/mishalhossin/Discord-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/mishalhossin/Discord-Chatbot-Gpt4Free/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/mishalhossin/Discord-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/mishalhossin/Coding-Chatbot-Gpt4Free/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/mishalhossin/Discord-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
2023-05-01 03:35:00 +03:00
< / tr >
2023-07-09 16:11:54 +03:00
< tr >
< td > < a href = "https://github.com/MIDORIBIN/langchain-gpt4free" > < b > LangChain gpt4free< / b > < / a > < / td >
< td > < a href = "https://github.com/MIDORIBIN/langchain-gpt4free/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/MIDORIBIN/langchain-gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/MIDORIBIN/langchain-gpt4free/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/MIDORIBIN/langchain-gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/MIDORIBIN/langchain-gpt4free/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/MIDORIBIN/langchain-gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/MIDORIBIN/langchain-gpt4free/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/MIDORIBIN/langchain-gpt4free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< / tr >
2023-08-16 12:49:44 +03:00
< tr >
< td > < a href = "https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free" > < b > ChatGpt Telegram Bot< / b > < / a > < / td >
< td > < a href = "https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&labelColor=343b41" / > < / a > < / td >
< / tr >
2023-08-25 11:58:10 +03:00
< tr >
< td > < a href = "https://github.com/Lin-jun-xiang/action-translate-readme" > < b > Action Translate Readme< / b > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/action-translate-readme/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/Lin-jun-xiang/action-translate-readme?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/action-translate-readme/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/Lin-jun-xiang/action-translate-readme?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/action-translate-readme/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/Lin-jun-xiang/action-translate-readme?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/action-translate-readme/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/Lin-jun-xiang/action-translate-readme?style=flat-square&labelColor=343b41" / > < / a > < / td >
< / tr >
2023-08-29 10:06:16 +03:00
< tr >
< td > < a href = "https://github.com/Lin-jun-xiang/docGPT-streamlit" > < b > Langchain Document GPT< / b > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/docGPT-streamlit/stargazers" > < img alt = "Stars" src = "https://img.shields.io/github/stars/Lin-jun-xiang/docGPT-streamlit?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/docGPT-streamlit/network/members" > < img alt = "Forks" src = "https://img.shields.io/github/forks/Lin-jun-xiang/docGPT-streamlit?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/docGPT-streamlit/issues" > < img alt = "Issues" src = "https://img.shields.io/github/issues/Lin-jun-xiang/docGPT-streamlit?style=flat-square&labelColor=343b41" / > < / a > < / td >
< td > < a href = "https://github.com/Lin-jun-xiang/docGPT-streamlit/pulls" > < img alt = "Pull Requests" src = "https://img.shields.io/github/issues-pr/Lin-jun-xiang/docGPT-streamlit?style=flat-square&labelColor=343b41" / > < / a > < / td >
< / tr >
2023-05-01 01:29:27 +03:00
< / tbody >
< / table >
2023-06-24 04:47:00 +03:00
## Contribute
2023-04-26 01:49:08 +03:00
2023-06-24 04:47:00 +03:00
to add another provider, its very simple:
2023-07-28 13:07:17 +03:00
1. create a new file in [g4f/provider ](./g4f/provider ) with the name of the Provider
2. Implement a class that extends [BaseProvider ](./g4f/provider/base_provider.py ).
2023-03-29 22:00:39 +03:00
2023-06-24 04:47:00 +03:00
```py
2023-07-28 13:07:17 +03:00
from .base_provider import BaseProvider
from ..typing import CreateResult, Any
class HogeService(BaseProvider):
url = "http://hoge.com"
working = True
supports_gpt_35_turbo = True
@staticmethod
def create_completion(
model: str,
messages: list[dict[str, str]],
stream: bool,
**kwargs: Any,
) -> CreateResult:
pass
2023-05-05 02:09:13 +03:00
```
2023-07-28 13:07:17 +03:00
3. Here, you can adjust the settings, for example if the website does support streaming, set `working` to `True` ...
4. Write code to request the provider in `create_completion` and `yield` the response, *even if* its a one-time response, do not hesitate to look at other providers for inspiration
5. Add the Provider Name in [g4f/provider/__init__.py ](./g4f/provider/__init__.py )
2023-05-05 02:09:13 +03:00
2023-06-24 04:47:00 +03:00
```py
2023-07-28 13:07:17 +03:00
from .base_provider import BaseProvider
from .HogeService import HogeService
__all__ = [
HogeService,
]
2023-04-25 04:54:19 +03:00
```
2023-04-29 16:29:54 +03:00
2023-06-24 04:47:00 +03:00
6. You are done !, test the provider by calling it:
```py
import g4f
2023-04-29 16:29:54 +03:00
2023-08-18 11:33:43 +03:00
response = g4f.ChatCompletion.create(model='gpt-3.5-turbo', provider=g4f.Provider.PROVIDERNAME,
messages=[{"role": "user", "content": "test"}], stream=g4f.Provider.PROVIDERNAME.supports_stream)
2023-04-29 16:29:54 +03:00
2023-06-24 04:47:00 +03:00
for message in response:
print(message, flush=True, end='')
2023-04-29 16:29:54 +03:00
```
2023-04-24 03:25:28 +03:00
## ChatGPT clone
2023-04-29 16:29:54 +03:00
2023-08-20 22:12:13 +03:00
> We are currently implementing new features and trying to scale it, but please be patient as it may be unstable
2023-05-01 20:26:49 +03:00
> https://chat.g4f.ai/chat
2023-04-29 16:29:54 +03:00
> This site was developed by me and includes **gpt-4/3.5**, **internet access** and **gpt-jailbreak's** like DAN
2023-05-02 11:14:04 +03:00
> Run locally here: https://github.com/xtekky/chatgpt-clone
2023-05-01 01:18:57 +03:00
2023-04-29 16:29:54 +03:00
## Copyright:
This program is licensed under the [GNU GPL v3 ](https://www.gnu.org/licenses/gpl-3.0.txt )
2023-04-17 02:04:20 +03:00
2023-06-24 04:47:00 +03:00
## Copyright Notice:
2023-04-29 16:29:54 +03:00
2023-04-17 02:04:20 +03:00
```
2023-06-24 04:47:00 +03:00
xtekky/gpt4free: Copyright (C) 2023 xtekky
2023-04-17 02:04:20 +03:00
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 / > .
```
2023-05-01 01:29:27 +03:00
2023-06-24 04:47:00 +03:00
## Star History
2023-05-01 01:29:27 +03:00
< a href = "https://github.com/xtekky/gpt4free/stargazers" >
< img width = "500" alt = "Star History Chart" src = "https://api.star-history.com/svg?repos=xtekky/gpt4free&type=Date" >
2023-08-31 16:31:57 +03:00
< / a >
