mirror of
https://github.com/LLM-Red-Team/qwen-free-api.git
synced 2024-11-11 08:09:20 +08:00
update README
This commit is contained in:
parent
62456b2e52
commit
7ebc1d00ae
215
README.md
215
README.md
@ -29,6 +29,7 @@ ZhipuAI (智谱清言) 接口转API [glm-free-api](https://github.com/LLM-Red-Te
|
|||||||
|
|
||||||
* [声明](#声明)
|
* [声明](#声明)
|
||||||
* [在线体验](#在线体验)
|
* [在线体验](#在线体验)
|
||||||
|
* [效果示例](#效果示例)
|
||||||
* [接入准备](#接入准备)
|
* [接入准备](#接入准备)
|
||||||
|
|
||||||
## 在线体验
|
## 在线体验
|
||||||
@ -37,6 +38,32 @@ ZhipuAI (智谱清言) 接口转API [glm-free-api](https://github.com/LLM-Red-Te
|
|||||||
|
|
||||||
https://udify.app/chat/qOXzVl5kkvhQXM8r
|
https://udify.app/chat/qOXzVl5kkvhQXM8r
|
||||||
|
|
||||||
|
## 效果示例
|
||||||
|
|
||||||
|
### 验明正身
|
||||||
|
|
||||||
|
![验明正身](./doc/example-1.png)
|
||||||
|
|
||||||
|
### 多轮对话
|
||||||
|
|
||||||
|
![多轮对话](./doc/example-2.png)
|
||||||
|
|
||||||
|
### AI绘图
|
||||||
|
|
||||||
|
![AI绘图](./doc/example-3.png)
|
||||||
|
|
||||||
|
### 长文档解读
|
||||||
|
|
||||||
|
正在开发...
|
||||||
|
|
||||||
|
### 图像解析
|
||||||
|
|
||||||
|
正在开发...
|
||||||
|
|
||||||
|
### 10线程并发测试
|
||||||
|
|
||||||
|
![10线程并发测试](./doc/example-4.png)
|
||||||
|
|
||||||
## 接入准备
|
## 接入准备
|
||||||
|
|
||||||
从 [通义千问](https://tongyi.aliyun.com/qianwen) 登录
|
从 [通义千问](https://tongyi.aliyun.com/qianwen) 登录
|
||||||
@ -45,4 +72,190 @@ https://udify.app/chat/qOXzVl5kkvhQXM8r
|
|||||||
|
|
||||||
![获取login_tongyi_ticket](./doc/example-0.png)
|
![获取login_tongyi_ticket](./doc/example-0.png)
|
||||||
|
|
||||||
文档还在持续完善。
|
### 多账号接入
|
||||||
|
|
||||||
|
你可以通过提供多个账号的login_tongyi_ticket,并使用,拼接提供:
|
||||||
|
|
||||||
|
Authorization: Bearer TOKEN1,TOKEN2,TOKEN3
|
||||||
|
|
||||||
|
每次请求服务会从中挑选一个。
|
||||||
|
|
||||||
|
## Docker部署
|
||||||
|
|
||||||
|
请准备一台具有公网IP的服务器并将8000端口开放。
|
||||||
|
|
||||||
|
拉取镜像并启动服务
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker run -it -d --init --name qwen-free-api -p 8000:8000 -e TZ=Asia/Shanghai vinlic/qwen-free-api:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
查看服务实时日志
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker logs -f qwen-free-api
|
||||||
|
```
|
||||||
|
|
||||||
|
重启服务
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker restart qwen-free-api
|
||||||
|
```
|
||||||
|
|
||||||
|
停止服务
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker stop qwen-free-api
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker-compose部署
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
version: '3'
|
||||||
|
|
||||||
|
services:
|
||||||
|
qwen-free-api:
|
||||||
|
container_name: qwen-free-api
|
||||||
|
image: vinlic/qwen-free-api:latest
|
||||||
|
restart: always
|
||||||
|
ports:
|
||||||
|
- "8000:8000"
|
||||||
|
environment:
|
||||||
|
- TZ=Asia/Shanghai
|
||||||
|
```
|
||||||
|
|
||||||
|
## 原生部署
|
||||||
|
|
||||||
|
请准备一台具有公网IP的服务器并将8000端口开放。
|
||||||
|
|
||||||
|
请先安装好Node.js环境并且配置好环境变量,确认node命令可用。
|
||||||
|
|
||||||
|
安装依赖
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npm i
|
||||||
|
```
|
||||||
|
|
||||||
|
安装PM2进行进程守护
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npm i -g pm2
|
||||||
|
```
|
||||||
|
|
||||||
|
编译构建,看到dist目录就是构建完成
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
启动服务
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pm2 start dist/index.js --name "qwen-free-api"
|
||||||
|
```
|
||||||
|
|
||||||
|
查看服务实时日志
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pm2 logs qwen-free-api
|
||||||
|
```
|
||||||
|
|
||||||
|
重启服务
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pm2 reload qwen-free-api
|
||||||
|
```
|
||||||
|
|
||||||
|
停止服务
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pm2 stop qwen-free-api
|
||||||
|
```
|
||||||
|
|
||||||
|
## 接口列表
|
||||||
|
|
||||||
|
目前支持与openai兼容的 `/v1/chat/completions` 接口,可自行使用与openai或其他兼容的客户端接入接口,或者使用 [dify](https://dify.ai/) 等线上服务接入使用。
|
||||||
|
|
||||||
|
### 对话补全
|
||||||
|
|
||||||
|
对话补全接口,与openai的 [chat-completions-api](https://platform.openai.com/docs/guides/text-generation/chat-completions-api) 兼容。
|
||||||
|
|
||||||
|
**POST /v1/chat/completions**
|
||||||
|
|
||||||
|
header 需要设置 Authorization 头部:
|
||||||
|
|
||||||
|
```
|
||||||
|
Authorization: Bearer [refresh_token]
|
||||||
|
```
|
||||||
|
|
||||||
|
请求数据:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
// 模型名称随意填写
|
||||||
|
"model": "qwen",
|
||||||
|
"messages": [
|
||||||
|
{
|
||||||
|
"role": "user",
|
||||||
|
"content": "你是谁?"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
// 如果使用SSE流请设置为true,默认false
|
||||||
|
"stream": false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
响应数据:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "4c4267e7919a41baad8199414ceb5cea",
|
||||||
|
"model": "qwen",
|
||||||
|
"object": "chat.completion",
|
||||||
|
"choices": [
|
||||||
|
{
|
||||||
|
"index": 0,
|
||||||
|
"message": {
|
||||||
|
"role": "assistant",
|
||||||
|
"content": "我是阿里云研发的超大规模语言模型,我叫通义千问。"
|
||||||
|
},
|
||||||
|
"finish_reason": "stop"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"usage": {
|
||||||
|
"prompt_tokens": 1,
|
||||||
|
"completion_tokens": 1,
|
||||||
|
"total_tokens": 2
|
||||||
|
},
|
||||||
|
"created": 1710152062
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 文档解读
|
||||||
|
|
||||||
|
正在开发...
|
||||||
|
|
||||||
|
### 图像解析
|
||||||
|
|
||||||
|
正在开发...
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
### Nginx反代优化
|
||||||
|
|
||||||
|
如果您正在使用Nginx反向代理qwen-free-api,请添加以下配置项优化流的输出效果,优化体验感。
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
# 关闭代理缓冲。当设置为off时,Nginx会立即将客户端请求发送到后端服务器,并立即将从后端服务器接收到的响应发送回客户端。
|
||||||
|
proxy_buffering off;
|
||||||
|
# 启用分块传输编码。分块传输编码允许服务器为动态生成的内容分块发送数据,而不需要预先知道内容的大小。
|
||||||
|
chunked_transfer_encoding on;
|
||||||
|
# 开启TCP_NOPUSH,这告诉Nginx在数据包发送到客户端之前,尽可能地发送数据。这通常在sendfile使用时配合使用,可以提高网络效率。
|
||||||
|
tcp_nopush on;
|
||||||
|
# 开启TCP_NODELAY,这告诉Nginx不延迟发送数据,立即发送小数据包。在某些情况下,这可以减少网络的延迟。
|
||||||
|
tcp_nodelay on;
|
||||||
|
# 设置保持连接的超时时间,这里设置为120秒。如果在这段时间内,客户端和服务器之间没有进一步的通信,连接将被关闭。
|
||||||
|
keepalive_timeout 120;
|
||||||
|
```
|
||||||
|
|
||||||
|
### Token统计
|
||||||
|
|
||||||
|
由于推理侧不在qwen-free-api,因此token不可统计,将以固定数字返回。
|
BIN
doc/example-1.png
Normal file
BIN
doc/example-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 18 KiB |
BIN
doc/example-2.png
Normal file
BIN
doc/example-2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 185 KiB |
BIN
doc/example-3.png
Normal file
BIN
doc/example-3.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 567 KiB |
BIN
doc/example-4.png
Normal file
BIN
doc/example-4.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 95 KiB |
Loading…
Reference in New Issue
Block a user