diff --git a/docs/config-azure-openai.md b/docs/config-azure-openai.md index 2d07c301b..0990bbea6 100644 --- a/docs/config-azure-openai.md +++ b/docs/config-azure-openai.md @@ -23,6 +23,17 @@ Azure OpenAI service instance, continue with the next section. In addition to using the UI, configuration can also be done using [environment variables](environment-variables.md). +## Server Configuration + +For server deployments, set these environment variables: + +```bash +AZURE_OPENAI_API_ENDPOINT=https://your-resource-name.openai.azure.com +AZURE_OPENAI_API_KEY=your-api-key +``` + +This enables Azure OpenAI for all users without requiring individual API keys. For more details, see [environment-variables.md](environment-variables.md). + ## Azure OpenAI API Versions Azure OpenAI supports both traditional deployment-based API and the next-generation v1 API: @@ -53,18 +64,7 @@ Azure OpenAI supports both traditional deployment-based API and the next-generat - Fill in the required fields and click on **Create** - Note down the **Subscription ID** (e.g., `12345678-1234-1234-1234-123456789012`) -### Step 2: Apply for Azure OpenAI Service - -We'll now be creating "OpenAI"-specific resources on Azure. This requires to 'apply', -and acceptance should be quick (even as low as minutes). - -1. Visit [Azure OpenAI Service](https://aka.ms/azure-openai) -2. Click on **Apply for access** - - Fill in the required fields (including the subscription ID) and click on **Apply** - -Once your application is accepted, you can create OpenAI resources on Azure. - -### Step 3: Create Azure OpenAI Resource +### Step 2: Create Azure OpenAI Resource For more information, see [Azure: Create and deploy OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal) @@ -74,31 +74,32 @@ For more information, see [Azure: Create and deploy OpenAI](https://learn.micros ![Creating an OpenAI service](pixels/config-azure-openai-create.png) - Select the subscription - Select a resource group or create a new one - - Select the region. Note that the region determines the available models. - > For instance, **Canada East** offers GPT-4-32k models, For the full list, see [GPT-4 models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models) + - Select the region. **Important**: The region determines which models are available. + > Popular regions like **East US**, **West Europe**, and **Australia East** typically have the best model availability. For the latest model availability by region, see [Azure OpenAI Model Availability](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models) - Name the service (e.g., `your-openai-api-1234`) - Select a pricing tier (e.g., `S0` for standard) - Select: "All networks, including the internet, can access this resource." - Click on **Review + create** and then **Create** -After creating the resource, you can access the API Keys and Endpoints. At any point, you can go to -the OpenAI Service instance page to get this information. +After creating the resource, you can access the API Keys and Endpoints: -- Click on **Go to resource** -- Click on **Develop** - - Copy the `Endpoint`, called "Language API", e.g. 'https://your-openai-api-1234.openai.azure.com/' - - Copy `KEY 1` +1. Click on **Go to resource** (or navigate to your Azure OpenAI resource) +2. In the left sidebar, under **Resource Management**, click on **Keys and Endpoint** +3. Copy the required information: + - **Endpoint**: e.g., 'https://your-resource-name.openai.azure.com/' + - **Key**: Copy either KEY 1 or KEY 2 (both work identically) -### Step 4: Deploy Models +### Step 3: Deploy Models By default, Azure OpenAI resource instances don't have models available. You need to deploy the models you want to use. -1. Click on **Model Deployments > Manage Deployments** -2. Click on **+Create New Deployment** - ![Deploying a model](pixels/config-azure-openai-deploy.png) - - Select the model you want to deploy - - Optionally select a version - - name the model, e.g., `gpt4-32k-0613` +1. In your Azure OpenAI resource, click on **Model deployments** in the left sidebar +2. Click on **Create new deployment** +3. Fill in the deployment details: + - **Select a model**: Choose from available models + - **Model version**: Select the latest version or a specific one + - **Deployment name**: Give it a meaningful name +4. Click **Deploy** Repeat as necessary for each model you want to deploy.