Repository files navigation

English |简体中文

Azure OpenAI Proxy is a tool that transforms OpenAI API requests into Azure OpenAI API requests, allowing OpenAI-compatible applications to seamlessly use Azure Open AI.

An Azure OpenAI account is required to use Azure OpenAI Proxy.

Remember to:

• Select the region that matches your Azure OpenAI resource for best performance.
• If deployment fails because the 'proxywebapp' name is already taken, change the resource prefix and redeploy.
• The deployed proxy app is part of a B1 pricing tier Azure web app plan, which can be modified in the Azure Portal after deployment.

To deploy using Docker, execute the following command:

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

Follow these steps:

1. Install NodeJS 20.
2. Clone the repository in the command line window.
3. Runnpm install to install the dependencies.
4. Runnpm start to start the application.
5. Use the script below for testing. ReplaceAZURE_RESOURCE_ID,AZURE_MODEL_DEPLOYMENT, andAZURE_API_KEY before running. The default value forAZURE_API_VERSION is2024-02-01 and is optional.

The azure-openai-proxy has been tested and confirmed to work with the following applications:

To test locally, follow these steps:

1. Clone the repository in a command-line window.
2. Update theOPENAI_API_KEY environment variable withAZURE_RESOURCE_ID:AZURE_MODEL_DEPLOYMENT:AZURE_API_KEY. Alternatively, update the OPENAI_API_KEY value in the docker-compose.yml file directly.
3. Navigate to the directory containing thedocker-compose.yml file for the application you want to test.
4. Execute the build command:docker-compose build.
5. Start the service:docker-compose up -d.
6. Access the application locally using the port defined in the docker-compose.yml file. For example, visithttp://localhost:3000.

We welcome all PR submissions.