返回提交历史
Modified
README.md
+22
-12
XFEstudio/gpt4free
feat(README.md): update readme for enhanced clarity and structure
b100bff8
代码差异
1 个文件
+22
-12
@@ -1,4 +1,5 @@
1
1
2
2
3
3
4
4
5
<a href="https://trendshift.io/repositories/1692" target="_blank"><img src="https://trendshift.io/api/badge/repositories/1692" alt="xtekky%2Fgpt4free | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
@@ -28,7 +29,7 @@ docker pull hlohaus789/g4f
28
29
```
29
30
30
31
## 🆕 What's New
31
- **For comprehensive details on new features and updates, please refer to our [Releases](https://github.com/xtekky/gpt4free/releases) page**
32
- **For comprehensive details on new features and updates, please refer to our** [Releases](https://github.com/xtekky/gpt4free/releases) **page**
32
33
- **Installation Guide for Windows (.exe):** 💻 [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)
33
34
- **Join our Telegram Channel:** 📨 [telegram.me/g4f_channel](https://telegram.me/g4f_channel)
34
35
- **Join our Discord Group:** 💬 [discord.gg/XfybzPXPH5](https://discord.gg/5E39JUWUFa)
@@ -70,6 +71,13 @@ Is your site on this repository and you want to take it down? Send an email to t
70
71
- [Interference API](#interference-api)
71
72
- [Local Inference](docs/local.md)
72
73
- [Configuration](#configuration)
74
- [Full Documentation for Python API](#full-documentation-for-python-api)
75
- **New:**
76
- [Async Client API from G4F](docs/async_client.md)
77
- [Client API like the OpenAI Python library](docs/client.md)
78
- **Legacy**
79
- [Legacy API with python modules](docs/legacy/legacy.md)
80
- [Legacy AsyncClient API from G4F](docs/legacy/legacy_async_client.md)
73
81
- [🚀 Providers and Models](docs/providers-and-models.md)
74
82
- [🔗 Powered by gpt4free](#-powered-by-gpt4free)
75
83
- [🤝 Contribute](#-contribute)
@@ -194,10 +202,14 @@ print(f"Generated image URL: {image_url}")
194
202
195
203
[](docs/client.md)
196
204
197
**Full Documentation for Python API**
198
- **Async Client API from G4F:** [/docs/async_client](docs/async_client.md)
199
- **Client API like the OpenAI Python library:** [/docs/client](docs/client.md)
200
- **Legacy API with python modules:** [/docs/legacy](docs/legacy.md)
205
#### **Full Documentation for Python API**
206
- **New:**
207
- **Async Client API from G4F:** [/docs/async_client](docs/async_client.md)
208
- **Client API like the OpenAI Python library:** [/docs/client](docs/client.md)
209
210
- **Legacy:**
211
- **Legacy API with python modules:** [/docs/legacy/legacy](docs/legacy/legacy.md)
212
- **Legacy AsyncClient API from G4F:** [/docs/async_client](docs/legacy/legacy_async_client.md)
201
213
202
214
#### Web UI
203
215
**To start the web interface, type the following codes in python:**
@@ -290,20 +302,18 @@ To utilize the OpenaiChat provider, a .har file is required from https://chatgpt
290
302
291
303
- Place the exported .har file in the `./har_and_cookies` directory if you are using Docker. Alternatively, you can store it in any preferred location within your current working directory.
292
304
293
Note: Ensure that your .har file is stored securely, as it may contain sensitive information.
305
> **Note:** Ensure that your .har file is stored securely, as it may contain sensitive information.
294
306
295
307
#### Using Proxy
296
308
297
309
If you want to hide or change your IP address for the providers, you can set a proxy globally via an environment variable:
298
310
299
- On macOS and Linux:
300
311
**- On macOS and Linux:**
301
312
```bash
302
313
export G4F_PROXY="http://host:port"
303
314
```
304
315
305
- On Windows:
306
316
**- On Windows:**
307
317
```bash
308
318
set G4F_PROXY=http://host:port
309
319
```
@@ -770,10 +780,10 @@ set G4F_PROXY=http://host:port
770
780
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.
771
781
772
782
###### Guide: How do i create a new Provider?
773
- Read: [Create Provider Guide](docs/guides/create_provider.md)
783
- **Read:** [Create Provider Guide](docs/guides/create_provider.md)
774
784
775
785
###### Guide: How can AI help me with writing code?
776
- Read: [AI Assistance Guide](docs/guides/help_me.md)
786
- **Read:** [AI Assistance Guide](docs/guides/help_me.md)
777
787
778
788
## 🙌 Contributors
779
789
A list of all contributors is available [here](https://github.com/xtekky/gpt4free/graphs/contributors)