Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
diemus committed Apr 2, 2023
1 parent 26ee79f commit 8e2c57a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,20 @@ Highlights:
- 🧠 Supports proxying all Azure OpenAI models and custom fine-tuned models
- 🗺️ Supports custom mapping between Azure deployment names and OpenAI models
- 🔄 Supports both reverse proxy and forward proxy usage
- 👍 Support mocking of OpenAI APIs that are not supported by Azure.


## Supported APIs

The latest version of the Azure OpenAI service currently supports the following 3 APIs:

| Path | Status |
| --------------------- | ------ |
| /v1/chat/completions ||
| /v1/completions ||
| /v1/embeddings ||

> Other APIs not supported by Azure will be returned in a mock format (such as OPTIONS requests initiated by browsers). If you find your project need additional OpenAI-supported APIs, feel free to submit a PR.
## Usage

Expand Down
13 changes: 13 additions & 0 deletions README.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,19 @@ OpenAI 请求,方便作为各类开源 ChatGPT 的后端使用。同时也支
- 🧠 支持代理所有 Azure OpenAI 模型以及自定义微调模型
- 🗺️ 支持自定义 Azure 部署名与 OpenAI 模型的映射关系
- 🔄 支持反向代理和正向代理两种方式使用
- 👍 支持对Azure不支持的OpenAI接口进行Mock

## 支持的接口

目前最新版本的Azure OpenAI服务支持以下3个接口:

| Path | Status |
| --------------------- |------|
| /v1/chat/completions ||
| /v1/completions ||
| /v1/embeddings ||

> 其他Azure不支持的接口会通过mock的形式返回(比如浏览器发起的OPTIONS类型的请求)。如果你发现需要某些额外的OpenAI支持的接口,欢迎提交PR
## 使用方式

Expand Down

0 comments on commit 8e2c57a

Please sign in to comment.