Migrate AzureOpenAI constructors to OpenAI client

Co-authored-by: pamelafox <[email protected]>

Author: Copilot

app/backend/app.py

@@ -426,8 +426,6 @@ async def setup_clients():
         os.getenv("AZURE_OPENAI_EMB_DEPLOYMENT") if OPENAI_HOST in [OpenAIHost.AZURE, OpenAIHost.AZURE_CUSTOM] else None
     )
     AZURE_OPENAI_CUSTOM_URL = os.getenv("AZURE_OPENAI_CUSTOM_URL")
-    # https://learn.microsoft.com/azure/ai-services/openai/api-version-deprecation#latest-ga-api-release
-    AZURE_OPENAI_API_VERSION = os.getenv("AZURE_OPENAI_API_VERSION") or "2024-10-21"
     AZURE_VISION_ENDPOINT = os.getenv("AZURE_VISION_ENDPOINT", "")
     AZURE_OPENAI_API_KEY_OVERRIDE = os.getenv("AZURE_OPENAI_API_KEY_OVERRIDE")
     # Used only with non-Azure OpenAI deployments
@@ -563,7 +561,6 @@ async def setup_clients():
     openai_client = setup_openai_client(
         openai_host=OPENAI_HOST,
         azure_credential=azure_credential,
-        azure_openai_api_version=AZURE_OPENAI_API_VERSION,
         azure_openai_service=AZURE_OPENAI_SERVICE,
         azure_openai_custom_url=AZURE_OPENAI_CUSTOM_URL,
         azure_openai_api_key=AZURE_OPENAI_API_KEY_OVERRIDE,
@@ -609,7 +606,6 @@ async def setup_clients():
             azure_openai_service=AZURE_OPENAI_SERVICE,
             azure_openai_custom_url=AZURE_OPENAI_CUSTOM_URL,
             azure_openai_deployment=AZURE_OPENAI_EMB_DEPLOYMENT,
-            azure_openai_api_version=AZURE_OPENAI_API_VERSION,
             azure_openai_key=clean_key_if_exists(AZURE_OPENAI_API_KEY_OVERRIDE),
             openai_key=clean_key_if_exists(OPENAI_API_KEY),
             openai_org=OPENAI_ORGANIZATION,

app/backend/prepdocs.py

@@ -164,7 +164,6 @@ def setup_embeddings_service(
     azure_openai_custom_url: Union[str, None],
     azure_openai_deployment: Union[str, None],
     azure_openai_key: Union[str, None],
-    azure_openai_api_version: str,
     openai_key: Union[str, None],
     openai_org: Union[str, None],
     disable_vectors: bool = False,
@@ -184,7 +183,6 @@ def setup_embeddings_service(
             open_ai_deployment=azure_openai_deployment,
             open_ai_model_name=emb_model_name,
             open_ai_dimensions=emb_model_dimensions,
-            open_ai_api_version=azure_openai_api_version,
             credential=azure_open_ai_credential,
             disable_batch=disable_batch_vectors,
         )
@@ -204,7 +202,6 @@ def setup_openai_client(
     openai_host: OpenAIHost,
     azure_credential: AsyncTokenCredential,
     azure_openai_api_key: Union[str, None] = None,
-    azure_openai_api_version: Union[str, None] = None,
     azure_openai_service: Union[str, None] = None,
     azure_openai_custom_url: Union[str, None] = None,
     openai_api_key: Union[str, None] = None,
@@ -228,16 +225,15 @@ def setup_openai_client(
             endpoint = f"https://{azure_openai_service}.openai.azure.com"
         if azure_openai_api_key:
             logger.info("AZURE_OPENAI_API_KEY_OVERRIDE found, using as api_key for Azure OpenAI client")
-            openai_client = AsyncAzureOpenAI(
-                api_version=azure_openai_api_version, azure_endpoint=endpoint, api_key=azure_openai_api_key
+            openai_client = AsyncOpenAI(
+                base_url=endpoint, api_key=azure_openai_api_key
             )
         else:
             logger.info("Using Azure credential (passwordless authentication) for Azure OpenAI client")
             token_provider = get_bearer_token_provider(azure_credential, "https://cognitiveservices.azure.com/.default")
-            openai_client = AsyncAzureOpenAI(
-                api_version=azure_openai_api_version,
-                azure_endpoint=endpoint,
-                azure_ad_token_provider=token_provider,
+            openai_client = AsyncOpenAI(
+                base_url=endpoint,
+                api_key=token_provider,
             )
     elif openai_host == OpenAIHost.LOCAL:
         logger.info("OPENAI_HOST is local, setting up local OpenAI client for OPENAI_BASE_URL with no key")
@@ -509,8 +505,6 @@ async def main(strategy: Strategy, setup_index: bool = True):
         datalake_key=clean_key_if_exists(args.datalakekey),
     )
 
-    # https://learn.microsoft.com/azure/ai-services/openai/api-version-deprecation#latest-ga-api-release
-    azure_openai_api_version = os.getenv("AZURE_OPENAI_API_VERSION") or "2024-06-01"
     emb_model_dimensions = 1536
     if os.getenv("AZURE_OPENAI_EMB_DIMENSIONS"):
         emb_model_dimensions = int(os.environ["AZURE_OPENAI_EMB_DIMENSIONS"])
@@ -522,7 +516,6 @@ async def main(strategy: Strategy, setup_index: bool = True):
         azure_openai_service=os.getenv("AZURE_OPENAI_SERVICE"),
         azure_openai_custom_url=os.getenv("AZURE_OPENAI_CUSTOM_URL"),
         azure_openai_deployment=os.getenv("AZURE_OPENAI_EMB_DEPLOYMENT"),
-        azure_openai_api_version=azure_openai_api_version,
         azure_openai_key=os.getenv("AZURE_OPENAI_API_KEY_OVERRIDE"),
         openai_key=clean_key_if_exists(os.getenv("OPENAI_API_KEY")),
         openai_org=os.getenv("OPENAI_ORGANIZATION"),
@@ -532,7 +525,6 @@ async def main(strategy: Strategy, setup_index: bool = True):
     openai_client = setup_openai_client(
         openai_host=OPENAI_HOST,
         azure_credential=azd_credential,
-        azure_openai_api_version=azure_openai_api_version,
         azure_openai_service=os.getenv("AZURE_OPENAI_SERVICE"),
         azure_openai_custom_url=os.getenv("AZURE_OPENAI_CUSTOM_URL"),
         azure_openai_api_key=os.getenv("AZURE_OPENAI_API_KEY_OVERRIDE"),

app/backend/prepdocslib/embeddings.py

@@ -164,7 +164,6 @@ def __init__(
         open_ai_deployment: Union[str, None],
         open_ai_model_name: str,
         open_ai_dimensions: int,
-        open_ai_api_version: str,
         credential: Union[AsyncTokenCredential, AzureKeyCredential],
         open_ai_custom_url: Union[str, None] = None,
         disable_batch: bool = False,
@@ -178,28 +177,28 @@ def __init__(
         else:
             raise ValueError("Either open_ai_service or open_ai_custom_url must be provided")
         self.open_ai_deployment = open_ai_deployment
-        self.open_ai_api_version = open_ai_api_version
         self.credential = credential
 
     async def create_client(self) -> AsyncOpenAI:
         class AuthArgs(TypedDict, total=False):
             api_key: str
-            azure_ad_token_provider: Callable[[], Union[str, Awaitable[str]]]
 
         auth_args = AuthArgs()
         if isinstance(self.credential, AzureKeyCredential):
             auth_args["api_key"] = self.credential.key
         elif isinstance(self.credential, AsyncTokenCredential):
-            auth_args["azure_ad_token_provider"] = get_bearer_token_provider(
+            token_provider = get_bearer_token_provider(
                 self.credential, "https://cognitiveservices.azure.com/.default"
             )
+            auth_args["api_key"] = token_provider
         else:
             raise TypeError("Invalid credential type")
 
-        return AsyncAzureOpenAI(
-            azure_endpoint=self.open_ai_endpoint,
-            azure_deployment=self.open_ai_deployment,
-            api_version=self.open_ai_api_version,
+        # For Azure OpenAI, we need to include the deployment in the URL
+        base_url = f"{self.open_ai_endpoint}/openai/deployments/{self.open_ai_deployment}"
+        
+        return AsyncOpenAI(
+            base_url=base_url,
             **auth_args,
         )
 

app/backend/requirements.in

@@ -1,7 +1,7 @@
 azure-identity
 quart
 quart-cors
-openai>=1.3.7
+openai>=1.108.1
 tiktoken
 tenacity
 azure-ai-documentintelligence==1.0.0b4

infra/main.bicep

@@ -56,7 +56,6 @@ param openAiHost string // Set in main.parameters.json
 param isAzureOpenAiHost bool = startsWith(openAiHost, 'azure')
 param deployAzureOpenAi bool = openAiHost == 'azure'
 param azureOpenAiCustomUrl string = ''
-param azureOpenAiApiVersion string = ''
 @secure()
 param azureOpenAiApiKey string = ''
 param azureOpenAiDisableKeys bool = true
@@ -442,7 +441,6 @@ var appEnvVariables = {
   AZURE_OPENAI_EMB_DEPLOYMENT: embedding.deploymentName
   AZURE_OPENAI_SEARCHAGENT_MODEL: searchAgent.modelName
   AZURE_OPENAI_SEARCHAGENT_DEPLOYMENT: searchAgent.deploymentName
-  AZURE_OPENAI_API_VERSION: azureOpenAiApiVersion
   AZURE_OPENAI_API_KEY_OVERRIDE: azureOpenAiApiKey
   AZURE_OPENAI_CUSTOM_URL: azureOpenAiCustomUrl
   // Used only with non-Azure OpenAI deployments
@@ -1346,7 +1344,6 @@ output AZURE_OPENAI_CHATGPT_MODEL string = chatGpt.modelName
 // Specific to Azure OpenAI
 output AZURE_OPENAI_SERVICE string = isAzureOpenAiHost && deployAzureOpenAi ? openAi.outputs.name : ''
 output AZURE_OPENAI_ENDPOINT string = isAzureOpenAiHost && deployAzureOpenAi ? openAi.outputs.endpoint : ''
-output AZURE_OPENAI_API_VERSION string = isAzureOpenAiHost ? azureOpenAiApiVersion : ''
 output AZURE_OPENAI_RESOURCE_GROUP string = isAzureOpenAiHost ? openAiResourceGroup.name : ''
 output AZURE_OPENAI_CHATGPT_DEPLOYMENT string = isAzureOpenAiHost ? chatGpt.deploymentName : ''
 output AZURE_OPENAI_CHATGPT_DEPLOYMENT_VERSION string = isAzureOpenAiHost ? chatGpt.deploymentVersion : ''

infra/main.parameters.json

@@ -173,9 +173,6 @@
     "azureOpenAiCustomUrl": {
       "value": "${AZURE_OPENAI_CUSTOM_URL}"
     },
-    "azureOpenAiApiVersion": {
-      "value": "${AZURE_OPENAI_API_VERSION}"
-    },
     "azureOpenAiApiKey": {
       "value": "${AZURE_OPENAI_API_KEY_OVERRIDE}"
     },