chore: update Azure OpenAI API version to 2024-12-01-preview in configurations

Author: pauldotyu

ai-service.yaml

@@ -33,7 +33,7 @@ spec:
             - name: AZURE_OPENAI_DALLE_ENDPOINT # required if using Azure OpenAI DALL-E
               value: ""
             - name: AZURE_OPENAI_API_VERSION # required if using Azure OpenAI DALL-E
-              value: "2024-02-15-preview"
+              value: "2024-12-01-preview"
             - name: AZURE_OPENAI_DALLE_DEPLOYMENT_NAME # required if using Azure OpenAI DALL-E
               value: ""
             - name: USE_LOCAL_LLM # set to True if you are using a local LLM provided by KAITO

charts/aks-store-demo/values.yaml

@@ -23,7 +23,7 @@ aiService:
   useAzureOpenAi: false
   openAiDalleEndpoint: ""
   openAiDalleModelName: ""
-  azureOpenAiApiVersion: "2024-02-15-preview"
+  azureOpenAiApiVersion: "2024-12-01-preview"
   image:
     repository: "ghcr.io/azure-samples/aks-store-demo/ai-service"
     tag: "" # defaults to Chart.AppVersion
@@ -90,12 +90,10 @@ virtualWorker:
 
 podAnnotations: {}
 
-podSecurityContext:
-  {}
+podSecurityContext: {}
   # fsGroup: 2000
 
-securityContext:
-  {}
+securityContext: {}
   # capabilities:
   #   drop:
   #   - ALL

src/ai-service/README.md

@@ -24,7 +24,7 @@ pip3 install -r requirements.txt
 
 export USE_AZURE_OPENAI=True # set to False if you are not using Azure OpenAI
 export USE_AZURE_AD=True # set to True if you are using Azure OpenAI with Azure AD authentication
-export AZURE_OPENAI_API_VERSION=2024-02-15-preview # set to the version of the Azure OpenAI API you are using https://learn.microsoft.com/azure/ai-services/openai/reference#rest-api-versioning
+export AZURE_OPENAI_API_VERSION=2024-12-01-preview # set to the version of the Azure OpenAI API you are using https://learn.microsoft.com/azure/ai-services/openai/reference#rest-api-versioning
 export AZURE_OPENAI_DEPLOYMENT_NAME= # required if using Azure OpenAI
 export AZURE_OPENAI_ENDPOINT= # required if using Azure OpenAI
 export AZURE_OPENAI_DALLE_ENDPOINT= # required if using Azure OpenAI's DALL-E model

src/ai-service/routers/description_generator.py

@@ -1,6 +1,7 @@
 """
 Description generation API endpoint.
 """
+
 import os
 import logging
 from typing import List
@@ -25,16 +26,17 @@
     "with the following tags: '{tags}'."
 )
 
+
 class DescriptionRequest(BaseModel):
     """Request model for the description generation endpoint."""
+
     name: str
     tags: List[str]
 
+
 # Create router with prefix
-description = APIRouter(
-    prefix="/generate",
-    tags=["generation"]
-)
+description = APIRouter(prefix="/generate", tags=["generation"])
+
 
 def _create_completion(client, model, prompt, system_prompt=SYSTEM_PROMPT):
     """Create a chat completion using the provided client and model"""
@@ -47,6 +49,7 @@ def _create_completion(client, model, prompt, system_prompt=SYSTEM_PROMPT):
         temperature=0,
     )
 
+
 def _handle_local_llm(user_prompt):
     """Handle local LLM completion"""
     logger.info("Using local LLM")
@@ -66,6 +69,7 @@ def _handle_local_llm(user_prompt):
     response = _create_completion(client, model, user_prompt)
     return response.choices[0].message.content
 
+
 def _handle_openai(user_prompt):
     """Handle OpenAI completion"""
     api_key = os.environ.get("OPENAI_API_KEY")
@@ -83,6 +87,7 @@ def _handle_openai(user_prompt):
     response = _create_completion(client, "gpt-3.5-turbo", user_prompt)
     return response.choices[0].message.content
 
+
 def _handle_azure_openai(user_prompt, use_azure_ad):
     """Handle Azure OpenAI completion"""
     deployment = os.environ.get("AZURE_OPENAI_DEPLOYMENT_NAME")
@@ -95,13 +100,12 @@ def _handle_azure_openai(user_prompt, use_azure_ad):
             "AZURE_OPENAI_DEPLOYMENT_NAME and AZURE_OPENAI_ENDPOINT must be provided"
         )
 
-    api_version = os.environ.get("AZURE_OPENAI_API_VERSION", "2024-02-15-preview")
+    api_version = os.environ.get("AZURE_OPENAI_API_VERSION", "2024-12-01-preview")
 
     if use_azure_ad:
         logger.info("Using Microsoft Entra authentication")
         token_provider = get_bearer_token_provider(
-            DefaultAzureCredential(),
-            "https://cognitiveservices.azure.com/.default"
+            DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
         )
 
         client = AzureOpenAI(
@@ -125,6 +129,7 @@ def _handle_azure_openai(user_prompt, use_azure_ad):
     response = _create_completion(client, deployment, user_prompt)
     return response.choices[0].message.content
 
+
 @description.post("/description", operation_id="generate_description")
 async def generate_description(request: DescriptionRequest):
     """
@@ -133,8 +138,7 @@ async def generate_description(request: DescriptionRequest):
     try:
         # Format the user prompt with the product name and tags
         user_prompt = USER_PROMPT_TEMPLATE.format(
-            name=request.name,
-            tags=", ".join(request.tags)
+            name=request.name, tags=", ".join(request.tags)
         )
 
         env_path = os.path.join(os.path.dirname(os.path.dirname(__file__)), ".env")
@@ -156,6 +160,5 @@ async def generate_description(request: DescriptionRequest):
         return {"description": description_text}
     except Exception as e:
         raise HTTPException(
-            status_code=500,
-            detail=f"Error generating description: {str(e)}"
+            status_code=500, detail=f"Error generating description: {str(e)}"
         ) from e

src/product-service/docker-compose.yml

@@ -7,7 +7,15 @@ services:
     ports:
       - 5001:5001
     healthcheck:
-      test: ["CMD", "wget", "-O", "/dev/null", "-q", "http://ai-service:5001/health"]
+      test:
+        [
+          "CMD",
+          "wget",
+          "-O",
+          "/dev/null",
+          "-q",
+          "http://ai-service:5001/health",
+        ]
       interval: 30s
       timeout: 10s
       retries: 5
@@ -17,7 +25,7 @@ services:
       - AZURE_OPENAI_ENDPOINT= # required if using Azure OpenAI
       - OPENAI_API_KEY= # always required
       - AZURE_OPENAI_DALLE_ENDPOINT= # required if using Azure OpenAI DALL-E
-      - AZURE_OPENAI_API_VERSION=2024-02-15-preview # required if using Azure OpenAI
+      - AZURE_OPENAI_API_VERSION=2024-12-01-preview # required if using Azure OpenAI
       - AZURE_OPENAI_DALLE_DEPLOYMENT_NAME= # required if using Azure OpenAI DALL-E
     networks:
       - backend_services