Skip to content

Commit

Permalink
Fix deployment url 404
Browse files Browse the repository at this point in the history
  • Loading branch information
blrchen committed Apr 16, 2023
1 parent 6e32dc2 commit 98f26c2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
8 changes: 5 additions & 3 deletions README.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ You must have an Azure OpenAI account to use the Azure OpenAI Proxy.

## Deploy to Azure

[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fscalaone%2Fazure-openai-proxy%2Fdeploy%2Fazure-deploy.json)
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fscalaone%2Fazure-openai-proxy%2Fmain%2Fdeploy%2Fazure-deploy.json)

## Docker Deployment

`docker run -d -p 3000:3000 scalaone/azure-openai-proxy`

## Local Running and Testing, Command Line Method
Expand All @@ -20,7 +22,7 @@ You must have an Azure OpenAI account to use the Azure OpenAI Proxy.
2. Clone the code in the command line window.
3. Run `npm install` to install dependencies.
4. Run `npm start` to start the application.
5. Run the script below for testing, replacing `YOUR_RESOURCE_ID`, `YOUR_MODEL_DEPLOYMENT`, and `YOUR_API_KEY` before running it, `AZURE_API_VERSION` is optional and the default value is 2023-03-15-preview..
5. Run the script below for testing, replacing `YOUR_RESOURCE_ID`, `YOUR_MODEL_DEPLOYMENT`, and `YOUR_API_KEY` before running it, `AZURE_API_VERSION` is optional and the default value is `2023-03-15-preview`.
```bash
curl -X "POST" "http://localhost:3000/v1/chat/completions" \
-H 'Authorization: YOUR_RESOURCE_ID:YOUR_MODEL_DEPLOYMENT:YOUR_API_KEY:AZURE_API_VERSION' \
Expand Down Expand Up @@ -50,7 +52,7 @@ curl -X "POST" "http://localhost:3000/v1/chat/completions" \
4. Start service: `run docker-compose up -d`
5. Launch `http://localhost:3000`

Frequently Asked Questions
## Frequently Asked Questions

Q: What is `YOUR_RESOURCE_ID`,`YOUR_MODEL_DEPLOYMENT`,`YOUR_API_KEY`?

Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@

## Azure部署

[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fscalaone%2Fazure-openai-proxy%2Fdeploy%2Fazure-deploy.json)
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fscalaone%2Fazure-openai-proxy%2Fmain%2Fdeploy%2Fazure-deploy.json)

## Docker Deployment

`docker run -d -p 3000:3000 scalaone/azure-openai-proxy`

## 本地运行和测试,命令行方式
Expand Down Expand Up @@ -45,12 +47,12 @@ curl -X "POST" "http://localhost:3000/v1/chat/completions" \
## 本地运行和测试,使用WebChat测试streaming

1. 克隆代码到命令行窗口
2. 更新 `docker-compose.yml` 文件中第九行的 `OPENAI_API_KEY` 环境变量,YOUR_RESOURCE_ID:gpt-35-turbo|YOUR_MODEL_DEPLOYMENT,gpt-4|YOUR_MODEL_DEPLOYMENT:YOUR_API_KEY
2. 更新 `docker-compose.yml` 文件中第九行的 `OPENAI_API_KEY` 环境变量,换成`YOUR_RESOURCE_ID:YOUR_MODEL_DEPLOYMENT:YOUR_API_KEY`
3. 执行构建:运行 `docker-compose build`
4. 启动服务:运行 `docker-compose up -d`
5. 运行`http://localhost:3000`

常见问题
## 常见问题

Q:什么是`YOUR_RESOURCE_ID``YOUR_MODEL_DEPLOYMENT``YOUR_API_KEY`

Expand Down

0 comments on commit 98f26c2

Please sign in to comment.