返回提交历史
Modified
README.md
+20
-21
XFEstudio/gpt4free
Update documenation links
528ccd3a
代码差异
1 个文件
+20
-21
@@ -45,7 +45,7 @@ docker pull hlohaus789/g4f
45
45
Reach out for help in our [Support Group: discord.gg/qXA4Wf4Fsm](https://discord.gg/qXA4Wf4Fsm).
46
46
47
47
- **Read our Documentation** 📖
48
Find detailed guidance and resources at [gpt4free.github.io/docs](https://gpt4free.github.io/docs/main.html).
48
Find detailed guidance and resources at [gpt4free.github.io/docs](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/main.md).
49
49
50
50
## 🔻 Site Takedown
51
51
@@ -69,9 +69,9 @@ Is your site on this repository and you want to take it down? Send an email to t
69
69
- [📝 Text Generation](#-text-generation)
70
70
- [🎨 Image Generation](#-image-generation)
71
71
- [🌐 Web Interface](#-web-interface)
72
- [🖥️ Local Inference](https://gpt4free.github.io/docs/local.html)
72
- [🖥️ Local Inference](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/local.md)
73
73
- [🤖 Interference API](#-interference-api)
74
- [🛠️ Configuration](https://gpt4free.github.io/docs/configuration.html)
74
- [🛠️ Configuration](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/configuration.md)
75
75
- [📱 Run on Smartphone](#-run-on-smartphone)
76
76
- [📘 Full Documentation for Python API](#-full-documentation-for-python-api)
77
77
- [🚀 Providers and Models](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs%2Fproviders-and-models.md)
@@ -152,7 +152,7 @@ By following these steps, you should be able to successfully install and run the
152
152
pip install -U g4f[all]
153
153
```
154
154
155
> How do I install only parts or do disable parts? **Use partial requirements:** [/docs/requirements](https://gpt4free.github.io/docs/requirements.html)
155
> How do I install only parts or do disable parts? **Use partial requirements:** [/docs/requirements](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/requirements.md)
156
156
157
157
#### Install from Source:
158
158
```bash
@@ -161,7 +161,7 @@ cd gpt4free
161
161
pip install -r requirements.txt
162
162
```
163
163
164
> How do I load the project using git and installing the project requirements? **Read this tutorial and follow it step by step:** [/docs/git](https://gpt4free.github.io/docs/git.html)
164
> How do I load the project using git and installing the project requirements? **Read this tutorial and follow it step by step:** [/docs/git](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/git.md)
165
165
166
166
---
167
167
@@ -196,7 +196,7 @@ response = client.images.generate(
196
196
197
197
print(f"Generated image URL: {response.data[0].url}")
198
198
```
199
[](https://gpt4free.github.io/docs/client.html)
199
[](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/client.md)
200
200
201
201
### 🌐 Web Interface
202
202
**Run the GUI using Python:**
@@ -214,7 +214,7 @@ python -m g4f.cli gui --port 8080 --debug
214
214
python -m g4f --port 8080 --debug
215
215
```
216
216
217
> **Learn More About the GUI:** For detailed instructions on how to set up, configure, and use the GPT4Free GUI, refer to the [GUI Documentation](https://gpt4free.github.io/docs/gui.html) . This guide includes step-by-step details on provider selection, managing conversations, using advanced features like speech recognition, and more.
217
> **Learn More About the GUI:** For detailed instructions on how to set up, configure, and use the GPT4Free GUI, refer to the [GUI Documentation](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/gui.md) . This guide includes step-by-step details on provider selection, managing conversations, using advanced features like speech recognition, and more.
218
218
219
219
---
220
220
@@ -222,28 +222,28 @@ python -m g4f --port 8080 --debug
222
222
223
223
The **Interference API** enables seamless integration with OpenAI's services through G4F, allowing you to deploy efficient AI solutions.
224
224
225
- **Documentation**: [Interference API Docs](https://gpt4free.github.io/docs/interference-api.html)
225
- **Documentation**: [Interference API Docs](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/interference-api.md)
226
226
- **Endpoint**: `http://localhost:1337/v1`
227
227
- **Swagger UI**: Explore the OpenAPI documentation via Swagger UI at `http://localhost:1337/docs`
228
- **Provider Selection**: [How to Specify a Provider?](https://gpt4free.github.io/docs/selecting_a_provider.html)
228
- **Provider Selection**: [How to Specify a Provider?](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/selecting_a_provider.md)
229
229
230
230
This API is designed for straightforward implementation and enhanced compatibility with other OpenAI integrations.
231
231
232
232
---
233
233
234
234
### 📱 Run on Smartphone
235
Run the Web UI on your smartphone for easy access on the go. Check out the dedicated guide to learn how to set up and use the GUI on your mobile device: [Run on Smartphone Guide](https://gpt4free.github.io/docs/guides/phone.html)
235
Run the Web UI on your smartphone for easy access on the go. Check out the dedicated guide to learn how to set up and use the GUI on your mobile device: [Run on Smartphone Guide](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/guides/phone.md)
236
236
237
237
---
238
238
239
239
#### **📘 Full Documentation for Python API**
240
- **Client API from G4F:** [/docs/client](https://gpt4free.github.io/docs/client.html)
241
- **AsyncClient API from G4F:** [/docs/async_client](https://gpt4free.github.io/docs/async_client.html)
242
- **Requests API from G4F:** [/docs/requests](https://gpt4free.github.io/docs/requests.html)
243
- **File API from G4F:** [/docs/file](https://gpt4free.github.io/docs/file.html)
244
- **PydanticAI and LangChain Integration for G4F:** [/docs/pydantic_ai](https://gpt4free.github.io/docs/pydantic_ai.html)
245
- **Legacy API with python modules:** [/docs/legacy](https://gpt4free.github.io/docs/legacy.html)
246
- **G4F - Media Documentation** [/docs/media](https://gpt4free.github.io/media.html) *(New)*
240
- **Client API from G4F:** [/docs/client](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/client.md)
241
- **AsyncClient API from G4F:** [/docs/async_client](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/async_client.md)
242
- **Requests API from G4F:** [/docs/requests](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/requests.md)
243
- **File API from G4F:** [/docs/file](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/file.md)
244
- **PydanticAI and LangChain Integration for G4F:** [/docs/pydantic_ai](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/pydantic_ai.md)
245
- **Legacy API with python modules:** [/docs/legacy](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/legacy.md)
246
- **G4F - Media Documentation** [/docs/media](https://github.com/gpt4free/gpt4free.github.io/media.md) *(New)*
247
247
248
248
---
249
249
@@ -711,10 +711,10 @@ Run the Web UI on your smartphone for easy access on the go. Check out the dedic
711
711
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.
712
712
713
713
###### Guide: How do i create a new Provider?
714
- **Read:** [Create Provider Guide](https://gpt4free.github.io/docs/guides/create_provider.html)
714
- **Read:** [Create Provider Guide](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/guides/create_provider.md)
715
715
716
716
###### Guide: How can AI help me with writing code?
717
- **Read:** [AI Assistance Guide](https://gpt4free.github.io/docs/guides/help_me.html)
717
- **Read:** [AI Assistance Guide](https://github.com/gpt4free/gpt4free.github.io/blob/main/docs/guides/help_me.md)
718
718
719
719
720
720
@@ -883,5 +883,4 @@ This project is licensed under <a href="https://github.com/xtekky/gpt4free/blob/
883
883
884
884
---
885
885
886
<p align="right">(<a href="#top">🔼 Back to top</a>)</p>
887
886
<p align="right">(<a href="#top">🔼 Back to top</a>)</p>