Merge pull request #32 from Azure-Samples/copilot/fix-31

Migrate AzureOpenAI constructors to OpenAI client

Author: pamelafox

README.md

@@ -117,19 +117,7 @@ A related option is VS Code Dev Containers, which will open the project in your
     azd env set AZURE_LOCATION "yournewlocationname"
     ```
 
-3. When `azd` has finished, you should have an OpenAI account you can use locally when logged into your Azure account. You can output the necessary environment variables into an `.env` file by running a script:
-
-    For Mac OS X / Linux:
-
-    ```shell
-    ./write_dot_env.sh
-    ```
-
-    For Windows:
-
-    ```shell
-    pwsh ./write_dot_env.ps1
-    ```
+3. Once the resources are provisioned, you should now see a local `.env` file with all the environment variables needed to run the scripts.
 
 4. Then you can proceed to [run the Python example](#running-the-python-example).
 
@@ -155,7 +143,7 @@ A related option is VS Code Dev Containers, which will open the project in your
 
 ### Costs
 
-This template creates only the Azure OpenAI resource, which is free to provision. However, you will be charged for the usage of the Azure OpenAI chat completions API. The pricing is based on the number of tokens used, with around 1-3 tokens used per word. You can find the pricing details for the OpenAI API on the [Azure Cognitive Services pricing page](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/).
+This template creates only the Azure OpenAI resource, which is free to provision. However, you will be charged for the usage of the Azure OpenAI chat completions API. The pricing is based on the number of tokens used, with around 1-3 tokens used per word. You can find the pricing details for the OpenAI API on the [Azure OpenAI pricing page](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/).
 
 ### Security guidelines
 

azure.yaml

@@ -2,4 +2,16 @@
 
 name: azure-openai-keyless-python
 metadata:
-  template: azure-openai-keyless-python@0.0.4
+  template: azure-openai-keyless-python@0.0.5
+hooks:
+  postprovision:
+    windows:
+      shell: pwsh
+      run: ./infra/write_dot_env.ps1
+      interactive: false
+      continueOnError: false
+    posix:
+      shell: sh
+      run: ./infra/write_dot_env.sh
+      interactive: false
+      continueOnError: false

example.py

@@ -15,20 +15,19 @@
     exit(1)
 
 
-credential = azure.identity.DefaultAzureCredential()
+# Change this to AzureCliCredential, DefaultAzureCredential, or another credential type if needed
+credential = azure.identity.AzureDeveloperCliCredential(tenant_id=os.environ["AZURE_TENANT_ID"])
 token_provider = azure.identity.get_bearer_token_provider(credential, "https://cognitiveservices.azure.com/.default")
 
-client = openai.AzureOpenAI(
-    api_version="2024-03-01-preview",
-    azure_endpoint=f"https://{os.getenv('AZURE_OPENAI_SERVICE')}.openai.azure.com",
-    azure_ad_token_provider=token_provider,
+client = openai.OpenAI(
+    base_url=f"https://{os.environ['AZURE_OPENAI_SERVICE']}.openai.azure.com/openai/v1",
+    api_key=token_provider,
 )
 
 response = client.chat.completions.create(
     # For Azure OpenAI, the model parameter must be set to the deployment name
-    model=os.getenv("AZURE_OPENAI_GPT_DEPLOYMENT"),
+    model=os.environ["AZURE_OPENAI_GPT_DEPLOYMENT"],
     temperature=0.7,
-    n=1,
     messages=[
         {"role": "system", "content": "You are a helpful assistant that makes lots of cat references and uses emojis."},
         {"role": "user", "content": "Write a haiku about a hungry cat who wants tuna"},

write_dot_env.ps1 renamed to infra/write_dot_env.ps1

@@ -4,6 +4,8 @@ Set-Content -Path .env -Value ""
 # Append new values to the .env file
 $azureOpenAiDeployment = azd env get-value AZURE_OPENAI_GPT_DEPLOYMENT
 $azureOpenAiService = azd env get-value AZURE_OPENAI_SERVICE
+$azureTenantId = azd env get-value AZURE_TENANT_ID
 
 Add-Content -Path .env -Value "AZURE_OPENAI_GPT_DEPLOYMENT=$azureOpenAiDeployment"
 Add-Content -Path .env -Value "AZURE_OPENAI_SERVICE=$azureOpenAiService"
+Add-Content -Path .env -Value "AZURE_TENANT_ID=$azureTenantId"

write_dot_env.sh renamed to infra/write_dot_env.sh

@@ -6,3 +6,4 @@
 # Append new values to the .env file
 echo "AZURE_OPENAI_GPT_DEPLOYMENT=$(azd env get-value AZURE_OPENAI_GPT_DEPLOYMENT)" >> .env
 echo "AZURE_OPENAI_SERVICE=$(azd env get-value AZURE_OPENAI_SERVICE)" >> .env
+echo "AZURE_TENANT_ID=$(azd env get-value AZURE_TENANT_ID)" >> .env

requirements.txt

@@ -1,3 +1,3 @@
 azure-identity
-openai
+openai>=1.108.1
 python-dotenv