Skip to content

Commit

Permalink
doc: migrate README
Browse files Browse the repository at this point in the history
  • Loading branch information
RockChinQ committed Oct 16, 2023
1 parent f16db27 commit 4480f79
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 39 deletions.
42 changes: 4 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,43 +46,9 @@

</details>

### 支持的 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 <id> <request count>`, X 轴为时间秒数, 每个色块为一次请求)

<img width="750" alt="image" src="assets/load_balance.png">
- GitHub Page: https://rockchinq.github.io/free-one-api
- 自部署文档:https://free-one-api.rockchin.top
16 changes: 16 additions & 0 deletions docs/zh-CN/Demo.md
Original file line number Diff line number Diff line change
@@ -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
23 changes: 23 additions & 0 deletions docs/zh-CN/README.md
Original file line number Diff line number Diff line change
@@ -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 <id> <request count>`, X 轴为时间秒数, 每个色块为一次请求)

![负载均衡性能](assets/load_balance.png)
3 changes: 2 additions & 1 deletion docs/zh-CN/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
* [部署](/zh-CN/Setup)
* [使用](/zh-CN/Usage)
* [适配器](/zh-CN/Adapters)
* [配置文件](/zh-CN/Config)
* [配置文件](/zh-CN/Config)
* [Demo测试](/zh-CN/Demo)
Binary file added docs/zh-CN/assets/load_balance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4480f79

Please sign in to comment.