Skip to content

Commit 9467e7b

Browse files
committed
docs: update 0.7.0
1 parent 51ee836 commit 9467e7b

File tree

5 files changed

+31
-11
lines changed

5 files changed

+31
-11
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ Convert different model APIs into the OpenAI API format out of the box.
88

99
当前支持模型:
1010

11-
- Azure OpenAI API (GPT 3.5/4)
12-
- Azure GPT4 Vision (GPT4v)
11+
- Azure OpenAI API (GPT 3.5/4), GPT4 Vision (GPT4v)
1312
- YI 34B API
1413
- Google Gemini Pro
1514

@@ -23,7 +22,7 @@ Convert different model APIs into the OpenAI API format out of the box.
2322
或者使用 Docker Pull,下载指定版本的镜像文件:
2423

2524
```bash
26-
docker pull soulteary/amazing-openai-api:v0.6.3
25+
docker pull soulteary/amazing-openai-api:v0.7.0
2726
```
2827

2928
## 快速上手
@@ -39,7 +38,7 @@ AZURE_ENDPOINT=https://你的部署名称.openai.azure.com/ ./aoa
3938
如果你更喜欢 Docker,可以用下面的命令:
4039

4140
```bash
42-
docker run --rm -it -e AZURE_ENDPOINT=https://suyang231210.openai.azure.com/ -p 8080:8080 soulteary/amazing-openai-api:v0.6.3
41+
docker run --rm -it -e AZURE_ENDPOINT=https://你的部署名称.openai.azure.com/ -p 8080:8080 soulteary/amazing-openai-api:v0.7.0
4342
```
4443

4544
当服务启动之后,我们就可以通过访问 `http://localhost:8080/v1` 来访问和 OpenAI 一样的 API 服务啦。
@@ -75,17 +74,14 @@ gpt-3.5-turbo:yi-34b-chat,gpt-4:yi-34b-chat
7574

7675
如果你希望使用 `yi-34b-chat`,或者 `gemini-pro`,我们需要设置 `AOA_TYPE=yi` 或者 `AOA_TYPE=gemini`,除此之外,没有任何差别。
7776

78-
### GPT4 Vision
79-
80-
如果你已经拥有了 Azure GPT Vision,除了使用 SDK 调用之外,你也可以参考这篇文档,使用 `curl` 进行调用:[GPT Vision](./example/gpt-vision.md)
81-
8277
## 容器快速上手
8378

8479
项目中包含当前支持的三种模型接口的 `docker compose` 示例文件,我们将 `example` 目录中的不同的文件,按需选择使用,将必填的信息填写完毕后,将文件修改为 `docker-compose.yml`
8580

8681
然后使用 `docker compose up` 启动服务,就能够快速使用啦。
8782

8883
- [docker-compose.azure.yml](./example/docker-compose.azure.yml)
84+
- [docker-compose.azure-gpt4v.yml](./example/docker-compose.azure-gpt4v.yml)
8985
- [docker-compose.yi.yml](./example/docker-compose.yi.yml)
9086
- [docker-compose.gemini.yml](./example/docker-compose.gemini.yml)
9187

@@ -132,6 +128,10 @@ AZURE_MODEL_ALIAS=gpt-3.5-turbo:gpt-35,gpt-4:gpt-35
132128
AZURE_ENDPOINT=https://<你的 Endpoint 地址>.openai.azure.com/ AZURE_MODEL_ALIAS=gpt-3.5-turbo:gpt-35 ./amazing-openai-api
133129
```
134130

131+
### GPT4 Vision
132+
133+
如果你已经拥有了 Azure GPT Vision,除了使用 SDK 调用之外,你也可以参考这篇文档,使用 `curl` 进行调用:[GPT Vision](./example/gpt-vision.md)
134+
135135
### 模型参数设置
136136

137137
```bash
@@ -143,6 +143,8 @@ AZURE_API_KEY
143143
AZURE_MODEL
144144
# (可选) API Version
145145
AZURE_API_VER
146+
# (可选) 是否是 Vision 实例
147+
ENV_AZURE_VISION
146148
# (可选) 模型映射别名
147149
AZURE_MODEL_ALIAS
148150
# (可选) Azure 网络代理
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
version: "3"
2+
3+
services:
4+
amazing-openai-api:
5+
image: soulteary/amazing-openai-api:v0.7.0
6+
restart: always
7+
ports:
8+
- 8080:8080
9+
environment:
10+
- AZURE_ENDPOINT=https://<修改为你的部署名称>.openai.azure.com/
11+
- AZURE_API_KEY=<修改为你的API KEY>
12+
- AZURE_VISION=true
13+
- AZURE_MODEL=gpt-4v
14+
# 模型名称映射,比如将请求中的 GPT 3.5 Turbo 映射为 GPT 4v
15+
- AZURE_MODEL_ALIAS=gpt-3.5-turbo:gpt-4v,gpt-4:gpt4v
16+
logging:
17+
options:
18+
max-size: 1m

example/docker-compose.azure.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "3"
22

33
services:
44
amazing-openai-api:
5-
image: soulteary/amazing-openai-api:v0.6.3
5+
image: soulteary/amazing-openai-api:v0.7.0
66
restart: always
77
ports:
88
- 8080:8080

example/docker-compose.gemini.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "3"
22

33
services:
44
amazing-openai-api:
5-
image: soulteary/amazing-openai-api:v0.6.3
5+
image: soulteary/amazing-openai-api:v0.7.0
66
restart: always
77
ports:
88
- 8080:8080

example/docker-compose.yi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "3"
22

33
services:
44
amazing-openai-api:
5-
image: soulteary/amazing-openai-api:v0.6.3
5+
image: soulteary/amazing-openai-api:v0.7.0
66
restart: always
77
ports:
88
- 8080:8080

0 commit comments

Comments
 (0)