Skip to content

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
geekr-dev committed Sep 22, 2023
1 parent 19a33ee commit b8c4a13
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,29 @@
### 切换到 Azure OpenAI

默认代理 OpenAI API,要想切换到 Azure OpenAI API,可以在 `scf_bootstrap` 的启动命令中添加域名参数来指定你的 Azure OpenAI API Endpoint:
默认在 9000 端口代理 OpenAI API,要想切换到 Azure OpenAI API,可以在 `scf_bootstrap` 的启动命令中添加域名参数来指定你的 Azure OpenAI API Endpoint:

```bash
./main -domain=your-azure-openai-endpoint
```

如果 9000 端口被占用,可以通过 `-post=9001` 指定其他端口。

### 代理任意全球域名

这个工具最早是为 OpenAI 代理而生,但实际上现在已经可以支持通过一个入口代理任意域名,只需要在发起发起代理请求的时候通过 `X-Target-Host` 设置你想要代理的域名(不带 `http(s)://` 前缀)即可,优先级是`请求头>命令行参数>默认值`

```go
req.Header.Set("x-target-host", "api.open.ai")
```

### 编译打包

```bash
./build.sh
```

此命令需要本地安装[go开发环境](https://go.dev/),如果不想本地安装 go 环境进行编译打包,可以直接下载根据最新源代码编译打包好的 `main.zip`[Release v1.0.0](https://github.com/geekr-dev/openai-proxy/releases/tag/v1.0.0)
此命令需要本地安装[go开发环境](https://go.dev/),如果不想本地安装 go 环境进行编译打包,可以直接下载根据最新源代码编译打包好的 `main.zip`[Release v1.0.1](https://github.com/geekr-dev/openai-proxy/releases/tag/v1.0.1)

### 部署测试

Expand All @@ -28,11 +38,11 @@

![](https://image.gstatics.cn/2023/03/06/image-20230306171340547.png)

你可以通过腾讯云云函数提供的测试工具进行测试,也可以本地通过 curl/postman 进行测试,使用的时候只需要将 `api.openai.com` 替换成代理域名 `open.aiproxy.xyz` 即可:
你可以通过腾讯云云函数提供的测试工具进行测试,也可以本地通过 curl/postman 进行测试,使用的时候只需要将 `api.openai.com` 替换成代理域名 `aiproxy.geekai.cc` 即可:

![](https://geekr.gstatics.cn/wp-content/uploads/2023/03/image-38.png)

你可以选择自己搭建,也可以直接使用我提供的代理域名 `open.aiproxy.xyz`,反正是免费的。关于代理背后的原理,可以看我在极客书房发布的这篇教程:[国内无法调用 OpenAI 接口的解决办法](https://geekr.dev/posts/chatgpt-website-by-laravel-10#toc-5)
你可以选择自己搭建,也可以直接使用我提供的代理域名 `aiproxy.geekai.cc`,反正是免费的。关于代理背后的原理,可以看我在极客书房发布的这篇教程:[国内无法调用 OpenAI 接口的解决办法](https://geekr.dev/posts/chatgpt-website-by-laravel-10#toc-5)

本地调试走VPN的话可以设置环境变量 `ENV=local`,然后直连 `api.openai.com`

Expand All @@ -48,7 +58,7 @@ if os.Getenv("ENV") == "local" {
```
### 流式响应支持

这个源代码本身是支持 stream 流式响应代理的,但目前腾讯云函数并不支持分块流式传输。所以,如果你需要实现流式响应,可以把编译后的二进制文件 `main` 丢到任意海外云服务器运行,这样就变成支持流式响应的 OpenAI HTTP 代理了,如果你不想折腾,可以使用我这边提供的 `aiproxy.geekai.cc` 作为代理进行测试:
这个源代码本身是支持 stream 流式响应代理的,但目前很多云函数并不支持分块流式传输。所以,如果你需要实现流式响应,可以把编译后的二进制文件 `main` 丢到任意海外云服务器运行,这样就变成支持流式响应的 OpenAI HTTP 代理了,如果你不想折腾,可以使用我这边提供的 `aiproxy.geekai.cc` 作为代理进行测试:

<img width="965" alt="image" src="https://user-images.githubusercontent.com/114386672/225609817-ca5c106b-22d4-4ae9-b3df-ca2c46d56843.png">

Expand Down

0 comments on commit b8c4a13

Please sign in to comment.