Skip to content

Commit 8914ef0

Browse files
committed
docs: add instruction for Cloudflare AI Gateway
1 parent c2c2984 commit 8914ef0

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/configuration_manual_CN.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99

1010
- 可选项
1111
- 默认值: `https://api.openai.com`
12+
- 说明
13+
- 自定义 API URL 可以解决服务不稳定以及 IP 被封禁的问题,切换到反向代理服务来提高稳定性,并保护我们的 IP 地址不被 OpenAI 封禁
14+
- 或者是使用一些云服务商提供的 API 网关服务,比如 Cloudflare AI Gateway,除了可以代理 OpenAI 的 API 请求外,还额外增加了缓存、调用分析以及日志管理等功能
15+
- 将 API URL 设置为 `https://gateway.ai.cloudflare.com/v1/${ACCOUNT_TAG}/${GATEWAY}/openai` 即可体验
16+
- 更多信息请参阅 [Cloudflare AI Gateway 官方文档](https://developers.cloudflare.com/ai-gateway/)
1217

1318
### Dep. Name
1419

@@ -64,4 +69,4 @@
6469
- 默认值: `translate from $sourceLang to $targetLang:/n/n $text`
6570
- 说明
6671
- 自定义 User Prompt,填写则会覆盖默认的 User Prompt
67-
- 可以使用与系统指令中相同的变量
72+
- 可以使用与系统指令中相同的变量

docs/configuration_manual_EN.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99

1010
- Optional
1111
- Default value: `https://api.openai.com`
12+
- Description
13+
- Customizing the API URL can address issues of service instability and IP bans by switching to a reverse proxy service to enhance stability and protect our IP address from being banned by OpenAI.
14+
- Alternatively, using API gateway services provided by cloud vendors, such as Cloudflare AI Gateway, not only proxies OpenAI API requests but also adds extra features like caching, call analytics, and log management.
15+
- Set the API URL to `https://gateway.ai.cloudflare.com/v1/${ACCOUNT_TAG}/${GATEWAY}/openai` to experience it.
16+
- For more information, please refer to [Cloudflare AI Gateway Official Documentation](https://developers.cloudflare.com/ai-gateway/).
1217

1318
### Dep. Name
1419

@@ -64,4 +69,4 @@
6469
- Default value: `translate from $sourceLang to $targetLang:/n/n $text`
6570
- Description
6671
- Customize User Prompt, filling this will override the default User Prompt
67-
- Can use the same variables as in the system command
72+
- Can use the same variables as in the system command

0 commit comments

Comments
 (0)