Add support for parameterizing model version (#76)

Author: pamelafox

.github/workflows/azure-dev.yaml

@@ -34,6 +34,7 @@ jobs:
       AZURE_OPENAI_ENDPOINT: ${{ vars.AZURE_OPENAI_ENDPOINT }}
       AZURE_OPENAI_REALTIME_DEPLOYMENT: ${{ vars.AZURE_OPENAI_REALTIME_DEPLOYMENT }}
       AZURE_OPENAI_REALTIME_DEPLOYMENT_CAPACITY: ${{ vars.AZURE_OPENAI_REALTIME_DEPLOYMENT_CAPACITY }}
+      AZURE_OPENAI_REALTIME_DEPLOYMENT_VERSION: ${{ vars.AZURE_OPENAI_REALTIME_DEPLOYMENT_VERSION }}
       AZURE_OPENAI_EMB_DEPLOYMENT_CAPACITY: ${{ vars.AZURE_OPENAI_EMB_DEPLOYMENT_CAPACITY }}
       AZURE_OPENAI_EMB_DIMENSIONS: ${{ vars.AZURE_OPENAI_EMB_DIMENSIONS }}
       AZURE_SEARCH_INDEX: ${{ vars.AZURE_SEARCH_INDEX }}

.github/workflows/template-validation.yaml

@@ -32,6 +32,7 @@ jobs:
           AZURE_OPENAI_ENDPOINT: ${{ vars.AZURE_OPENAI_ENDPOINT }}
           AZURE_OPENAI_REALTIME_DEPLOYMENT: ${{ vars.AZURE_OPENAI_REALTIME_DEPLOYMENT }}
           AZURE_OPENAI_REALTIME_DEPLOYMENT_CAPACITY: ${{ vars.AZURE_OPENAI_REALTIME_DEPLOYMENT_CAPACITY }}
+          AZURE_OPENAI_REALTIME_DEPLOYMENT_VERSION: ${{ vars.AZURE_OPENAI_REALTIME_DEPLOYMENT_VERSION }}
           AZURE_OPENAI_EMB_DEPLOYMENT_CAPACITY: ${{ vars.AZURE_OPENAI_EMB_DEPLOYMENT_CAPACITY }}
           AZURE_OPENAI_EMB_DIMENSIONS: ${{ vars.AZURE_OPENAI_EMB_DIMENSIONS }}
           AZURE_SEARCH_INDEX: ${{ vars.AZURE_SEARCH_INDEX }}

azure.yaml

@@ -30,6 +30,7 @@ pipeline:
     - AZURE_OPENAI_ENDPOINT
     - AZURE_OPENAI_REALTIME_DEPLOYMENT
     - AZURE_OPENAI_REALTIME_DEPLOYMENT_CAPACITY
+    - AZURE_OPENAI_REALTIME_DEPLOYMENT_VERSION
     - AZURE_OPENAI_EMB_DEPLOYMENT_CAPACITY
     - AZURE_OPENAI_EMB_DIMENSIONS
     - AZURE_SEARCH_INDEX

docs/customizing_deploy.md

@@ -15,3 +15,19 @@ The default voice choice is `alloy`, but 2 other voices are available.
 
 Once you have set the voice choice, run `azd up` to apply the changes to the deployed app.
 If you've already run `azd up` and want to first preview the voice with the development server, then update your local `.env` file by running `./scripts/write_env.sh` or `pwsh ./scripts/write_env.ps1`, and then restart the development server.
+
+## Customizing the Azure OpenAI deployment
+
+To use a different version for the real-time deployment, run this command:
+
+```bash
+azd env set AZURE_OPENAI_REALTIME_DEPLOYMENT_VERSION 2024-12-17
+```
+
+To specify a different capacity (the default is 1), run this command:
+
+```bash
+azd env set AZURE_OPENAI_REALTIME_DEPLOYMENT_CAPACITY 2
+```
+
+You will need to run `azd up` to apply the changes to the Azure OpenAI resource.

infra/main.bicep

@@ -88,6 +88,7 @@ param openAiRealtimeVoiceChoice string = ''
 param openAiServiceLocation string
 
 param realtimeDeploymentCapacity int
+param realtimeDeploymentVersion string
 param embeddingDeploymentCapacity int
 
 param tenantId string = tenant().tenantId
@@ -227,7 +228,7 @@ var openAiDeployments = [
     model: {
       format: 'OpenAI'
       name: 'gpt-4o-realtime-preview'
-      version: '2024-10-01'
+      version: realtimeDeploymentVersion
     }
     sku: {
       name: 'GlobalStandard'

infra/main.parameters.json

@@ -92,6 +92,9 @@
     "realtimeDeploymentCapacity": {
       "value": "${AZURE_OPENAI_REALTIME_DEPLOYMENT_CAPACITY=1}"
     },
+    "realtimeDeploymentVersion": {
+      "value": "${AZURE_OPENAI_REALTIME_DEPLOYMENT_VERSION=2024-10-01}"
+    },
     "embeddingDeploymentCapacity": {
       "value": "${AZURE_OPENAI_EMB_DEPLOYMENT_CAPACITY=30}"
     },