diff --git a/README.md b/README.md index a2fe1ce..f754439 100644 --- a/README.md +++ b/README.md @@ -46,43 +46,9 @@ -### 支持的 LLM 库 +## 文档 -|Adapter|Multi Round|Stream|Function Call|Status|Comment| -|---|---|---|---|---|---| -|[acheong08/ChatGPT](https://github.com/acheong08/ChatGPT)|✅|✅|❌|✅|ChatGPT 网页版| -|[KoushikNavuluri/Claude-API](https://github.com/KoushikNavuluri/Claude-API)|✅|❌|❌|✅|Claude 网页版| -|[dsdanielpark/Bard-API](https://github.com/dsdanielpark/Bard-API)|✅|❌|❌|✅|Google Bard 网页版| -|[xtekky/gpt4free](https://github.com/xtekky/gpt4free)|✅|✅|❌|✅|gpt4free 接入多个平台的破解| -|[Soulter/hugging-chat-api](https://github.com/Soulter/hugging-chat-api)|✅|✅|❌|✅|huggingface的对话模型| -|[xw5xr6/revTongYi](https://github.com/xw5xr6/revTongYi)|✅|✅|❌|✅|阿里云通义千问网页版| +部署、配置方式请参考文档: -### 支持的 API 路径 - -- `/v1/chat/completions` - -欢迎提交 issue 或 pull request 来添加更多的 LLM 库和 API 路径支持。 - -## 快速体验 - -### Demo - -可以登录并修改通道和key数据,每30分钟重置(xx:00/xx:30). - -地址:https://foa-demo.rockchin.top -密码:12345678 - -### 测试通道 - -仅可使用通道,不可登录: - -api_base: https://foa.rockchin.top/v1 -api_key: sk-foaDfZxzvfrwfqkBDJEMq7C0rdXkhOjXx4aM23pH42tv8SJ4 -model: gpt-3.5-turbo - -## 负载均衡性能 - -启用4个通道,客户端16个线程的请求时间甘特图,请求提问“write a quick sort in Java”: -(通道标记为 `Channel ID `, X 轴为时间秒数, 每个色块为一次请求) - -image +- GitHub Page: https://rockchinq.github.io/free-one-api +- 自部署文档:https://free-one-api.rockchin.top \ No newline at end of file diff --git a/docs/zh-CN/Demo.md b/docs/zh-CN/Demo.md new file mode 100644 index 0000000..f8ee187 --- /dev/null +++ b/docs/zh-CN/Demo.md @@ -0,0 +1,16 @@ +# 快速体验 + +## Demo + +可以登录并修改通道和key数据,每30分钟重置(xx:00/xx:30). + +地址:https://foa-demo.rockchin.top +密码:12345678 + +## 测试通道 + +仅可使用通道,不可登录: + +api_base: https://foa.rockchin.top/v1 +api_key: sk-foaDfZxzvfrwfqkBDJEMq7C0rdXkhOjXx4aM23pH42tv8SJ4 +model: gpt-3.5-turbo diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 7228c09..7fda358 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -1,2 +1,25 @@ # Free One API 中文文档 +## 支持的 LLM 库 + +|Adapter|Multi Round|Stream|Function Call|Status|Comment| +|---|---|---|---|---|---| +|[acheong08/ChatGPT](https://github.com/acheong08/ChatGPT)|✅|✅|❌|✅|ChatGPT 网页版| +|[KoushikNavuluri/Claude-API](https://github.com/KoushikNavuluri/Claude-API)|✅|❌|❌|✅|Claude 网页版| +|[dsdanielpark/Bard-API](https://github.com/dsdanielpark/Bard-API)|✅|❌|❌|✅|Google Bard 网页版| +|[xtekky/gpt4free](https://github.com/xtekky/gpt4free)|✅|✅|❌|✅|gpt4free 接入多个平台的破解| +|[Soulter/hugging-chat-api](https://github.com/Soulter/hugging-chat-api)|✅|✅|❌|✅|huggingface的对话模型| +|[xw5xr6/revTongYi](https://github.com/xw5xr6/revTongYi)|✅|✅|❌|✅|阿里云通义千问网页版| + +## 支持的 API 路径 + +- `/v1/chat/completions` + +欢迎提交 issue 或 pull request 来添加更多的 LLM 库和 API 路径支持。 + +## 负载均衡性能 + +启用4个通道,客户端16个线程的请求时间甘特图,请求提问“write a quick sort in Java”: +(通道标记为 `Channel ID `, X 轴为时间秒数, 每个色块为一次请求) + +![负载均衡性能](assets/load_balance.png) \ No newline at end of file diff --git a/docs/zh-CN/_sidebar.md b/docs/zh-CN/_sidebar.md index 5f4c489..0298388 100644 --- a/docs/zh-CN/_sidebar.md +++ b/docs/zh-CN/_sidebar.md @@ -2,4 +2,5 @@ * [部署](/zh-CN/Setup) * [使用](/zh-CN/Usage) * [适配器](/zh-CN/Adapters) -* [配置文件](/zh-CN/Config) \ No newline at end of file +* [配置文件](/zh-CN/Config) +* [Demo测试](/zh-CN/Demo) \ No newline at end of file diff --git a/docs/zh-CN/assets/load_balance.png b/docs/zh-CN/assets/load_balance.png new file mode 100644 index 0000000..0cee5c0 Binary files /dev/null and b/docs/zh-CN/assets/load_balance.png differ