Merge pull request #267104 from aahill/app-support

updating evironment vars

Author: American-Dipper

articles/ai-services/openai/concepts/use-your-data.md

@@ -361,9 +361,9 @@ You can send a streaming request using the `stream` parameter, allowing data to
         {
             "type": "AzureCognitiveSearch",
             "parameters": {
-                "endpoint": "'$SearchEndpoint'",
-                "key": "'$SearchKey'",
-                "indexName": "'$SearchIndex'"
+                "endpoint": "'$AZURE_AI_SEARCH_ENDPOINT'",
+                "key": "'$AZURE_AI_SEARCH_API_KEY'",
+                "indexName": "'$AZURE_AI_SEARCH_INDEX'"
             }
         }
     ],
@@ -386,9 +386,9 @@ When you chat with a model, providing a history of the chat will help the model
         {
             "type": "AzureCognitiveSearch",
             "parameters": {
-                "endpoint": "'$SearchEndpoint'",
-                "key": "'$SearchKey'",
-                "indexName": "'$SearchIndex'"
+                "endpoint": "'$AZURE_AI_SEARCH_ENDPOINT'",
+                "key": "'$AZURE_AI_SEARCH_API_KEY'",
+                "indexName": "'$AZURE_AI_SEARCH_INDEX'"
             }
         }
     ],

articles/ai-services/openai/how-to/migration.md

@@ -1,13 +1,13 @@
 ---
 title: How to migrate to OpenAI Python v1.x
 titleSuffix: Azure OpenAI Service
-description: Learn about migrating to the latest release of the OpenAI Python library with Azure OpenAI
+description: Learn about migrating to the latest release of the OpenAI Python library with Azure OpenAI.
 author: mrbullwinkle 
 ms.author: mbullwin 
 ms.service: azure-ai-openai
 ms.custom: devx-track-python
 ms.topic: how-to
-ms.date: 11/15/2023
+ms.date: 02/26/2024
 manager: nitinme
 ---
 
@@ -17,7 +17,7 @@ OpenAI has just released a new version of the [OpenAI Python API library](https:
 
 ## Updates
 
-- This is a completely new version of the OpenAI Python API library.
+- This is a new version of the OpenAI Python API library.
 - Starting on November 6, 2023 `pip install openai` and `pip install openai --upgrade` will install `version 1.x` of the OpenAI Python library.
 - Upgrading from `version 0.28.1` to `version 1.x` is a breaking change, you'll need to test and update your code.  
 - Auto-retry with backoff if there's an error
@@ -259,7 +259,7 @@ print(completion.model_dump_json(indent=2))
 
 ## Use your data
 
-For the full configuration steps that are required to make these code examples work, please consult the [use your data quickstart](../use-your-data-quickstart.md).
+For the full configuration steps that are required to make these code examples work, consult the [use your data quickstart](../use-your-data-quickstart.md).
 # [OpenAI Python 0.28.1](#tab/python)
 
 ```python
@@ -270,10 +270,10 @@ import requests
 
 dotenv.load_dotenv()
 
-openai.api_base = os.environ.get("AOAIEndpoint")
+openai.api_base = os.environ.get("AZURE_OPENAI_ENDPOINT")
 openai.api_version = "2023-08-01-preview"
 openai.api_type = 'azure'
-openai.api_key = os.environ.get("AOAIKey")
+openai.api_key = os.environ.get("AZURE_OPENAI_API_KEY")
 
 def setup_byod(deployment_id: str) -> None:
     """Sets up the OpenAI Python SDK to use your own data for the chat endpoint.
@@ -299,19 +299,19 @@ def setup_byod(deployment_id: str) -> None:
 
     openai.requestssession = session
 
-aoai_deployment_id = os.environ.get("AOAIDeploymentId")
+aoai_deployment_id = os.environ.get("AZURE_OPEN_AI_DEPLOYMENT_ID")
 setup_byod(aoai_deployment_id)
 
 completion = openai.ChatCompletion.create(
     messages=[{"role": "user", "content": "What are the differences between Azure Machine Learning and Azure AI services?"}],
-    deployment_id=os.environ.get("AOAIDeploymentId"),
+    deployment_id=os.environ.get("AZURE_OPEN_AI_DEPLOYMENT_ID"),
     dataSources=[  # camelCase is intentional, as this is the format the API expects
         {
             "type": "AzureCognitiveSearch",
             "parameters": {
-                "endpoint": os.environ.get("SearchEndpoint"),
-                "key": os.environ.get("SearchKey"),
-                "indexName": os.environ.get("SearchIndex"),
+                "endpoint": os.environ.get("AZURE_AI_SEARCH_ENDPOINT"),
+                "key": os.environ.get("AZURE_AI_SEARCH_API_KEY"),
+                "indexName": os.environ.get("AZURE_AI_SEARCH_INDEX"),
             }
         }
     ]
@@ -328,9 +328,9 @@ import dotenv
 
 dotenv.load_dotenv()
 
-endpoint = os.environ.get("AOAIEndpoint")
-api_key = os.environ.get("AOAIKey")
-deployment = os.environ.get("AOAIDeploymentId")
+endpoint = os.environ.get("AZURE_OPENAI_ENDPOINT")
+api_key = os.environ.get("AZURE_OPENAI_API_KEY")
+deployment = os.environ.get("AZURE_OPEN_AI_DEPLOYMENT_ID")
 
 client = openai.AzureOpenAI(
     base_url=f"{endpoint}/openai/deployments/{deployment}/extensions",
@@ -351,9 +351,9 @@ completion = client.chat.completions.create(
             {
                 "type": "AzureCognitiveSearch",
                 "parameters": {
-                    "endpoint": os.environ["SearchEndpoint"],
-                    "key": os.environ["SearchKey"],
-                    "indexName": os.environ["SearchIndex"]
+                    "endpoint": os.environ["AZURE_AI_SEARCH_ENDPOINT"],
+                    "key": os.environ["AZURE_AI_SEARCH_API_KEY"],
+                    "indexName": os.environ["AZURE_AI_SEARCH_INDEX"]
                 }
             }
         ]

articles/ai-services/openai/how-to/use-web-app.md

@@ -7,7 +7,7 @@ ms.service: azure-ai-openai
 ms.topic: how-to
 author: aahill
 ms.author: aahi
-ms.date: 02/09/2024
+ms.date: 02/23/2024
 recommendations: false
 ---
 
@@ -43,6 +43,8 @@ When customizing the app, we recommend:
 
 - When you rotate API keys for your Azure OpenAI or Azure AI Search resource, be sure to update the app settings for each of your deployed apps to use the new keys.
 
+Sample source code for Azure OpenAI On Your Data web app is available on [GitHub](https://github.com/microsoft/sample-app-aoai-chatGPT). Source code is provided "as is" and as a sample only. Customers are responsible for all customization and implementation of their web apps using Azure OpenAI On Your Data. 
+
 ### Updating the web app
 
 We recommend pulling changes from the `main` branch for the web app's source code frequently to ensure you have the latest bug fixes, API version, and improvements.

articles/ai-services/openai/how-to/use-your-data-securely.md

@@ -90,9 +90,9 @@ When using the API, pass the `filter` parameter in each API request. For example
         {
             "type": "AzureCognitiveSearch",
             "parameters": {
-                "endpoint": "'$SearchEndpoint'",
-                "key": "'$SearchKey'",
-                "indexName": "'$SearchIndex'",
+                "endpoint": "'$AZURE_AI_SEARCH_ENDPOINT'",
+                "key": "'$AZURE_AI_SEARCH_API_KEY'",
+                "indexName": "'$AZURE_AI_SEARCH_INDEX'",
                 "filter": "my_group_ids/any(g:search.in(g, 'group_id1, group_id2'))"
             }
         }

articles/ai-services/openai/includes/use-your-data-common-variables.md

@@ -14,82 +14,82 @@ To successfully make a call against Azure OpenAI, you need the following variabl
 
 |Variable name | Value |
 |--------------------------|-------------|
-| `AOAIEndpoint`               | This value can be found in the **Keys & Endpoint** section when examining your Azure OpenAI resource from the Azure portal. Alternatively, you can find the value in **Azure AI studio** > **Chat playground** > **Code view**. An example endpoint is: `https://my-resoruce.openai.azure.com`.|
-| `AOAIKey` | This value can be found in **Resource management** > **Keys & Endpoint** section when examining your Azure OpenAI resource from the Azure portal. You can use either `KEY1` or `KEY2`. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption. |
-| `AOAIDeploymentId` | This value corresponds to the custom name you chose for your deployment when you deployed a model. This value can be found under **Resource Management** > **Deployments** in the Azure portal or alternatively under **Management** > **Deployments** in Azure AI studio.|
-| `SearchEndpoint` | This value can be found in the **Overview** section when examining your Azure AI Search resource from the Azure portal. |
-| `SearchKey` | This value can be found in the **Settings** > **Keys** section when examining your Azure AI Search resource from the Azure portal. You can use either the primary admin key or secondary admin key. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption. |
-| `SearchIndex` | This value corresponds to the name of the index you created to store your data. You can find it in the **Overview** section when examining your Azure AI Search resource from the Azure portal. |
+| `AZURE_OPENAI_ENDPOINT`               | This value can be found in the **Keys & Endpoint** section when examining your Azure OpenAI resource from the Azure portal. Alternatively, you can find the value in **Azure AI studio** > **Chat playground** > **Code view**. An example endpoint is: `https://my-resoruce.openai.azure.com`.|
+| `AZURE_OPENAI_API_KEY` | This value can be found in **Resource management** > **Keys & Endpoint** section when examining your Azure OpenAI resource from the Azure portal. You can use either `KEY1` or `KEY2`. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption. |
+| `AZURE_OPEN_AI_DEPLOYMENT_ID` | This value corresponds to the custom name you chose for your deployment when you deployed a model. This value can be found under **Resource Management** > **Deployments** in the Azure portal or alternatively under **Management** > **Deployments** in Azure AI studio.|
+| `AZURE_AI_SEARCH_ENDPOINT` | This value can be found in the **Overview** section when examining your Azure AI Search resource from the Azure portal. |
+| `AZURE_AI_SEARCH_API_KEY` | This value can be found in the **Settings** > **Keys** section when examining your Azure AI Search resource from the Azure portal. You can use either the primary admin key or secondary admin key. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption. |
+| `AZURE_AI_SEARCH_INDEX` | This value corresponds to the name of the index you created to store your data. You can find it in the **Overview** section when examining your Azure AI Search resource from the Azure portal. |
 
 ### Environment variables
 
 # [Command Line](#tab/command-line)
 
 ```CMD
-setx AOAIEndpoint REPLACE_WITH_YOUR_AOAI_ENDPOINT_VALUE_HERE
+setx AZURE_OPENAI_ENDPOINT REPLACE_WITH_YOUR_AOAI_ENDPOINT_VALUE_HERE
 ```
 ```CMD
-setx AOAIKey REPLACE_WITH_YOUR_AOAI_KEY_VALUE_HERE
+setx AZURE_OPENAI_API_KEY REPLACE_WITH_YOUR_AOAI_KEY_VALUE_HERE
 ```
 ```CMD
-setx AOAIDeploymentId REPLACE_WITH_YOUR_AOAI_DEPLOYMENT_VALUE_HERE
+setx AZURE_OPENAI_DEPLOYMENT_ID REPLACE_WITH_YOUR_AOAI_DEPLOYMENT_VALUE_HERE
 ```
 ```CMD
-setx SearchEndpoint REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_VALUE_HERE
+setx AZURE_AI_SEARCH_ENDPOINT REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_VALUE_HERE
 ```
 ```CMD
-setx SearchKey REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_KEY_VALUE_HERE
+setx AZURE_AI_SEARCH_API_KEY REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_KEY_VALUE_HERE
 ```
 ```CMD
-setx SearchIndex REPLACE_WITH_YOUR_INDEX_NAME_HERE
+setx AZURE_AI_SEARCH_INDEX REPLACE_WITH_YOUR_INDEX_NAME_HERE
 ```
 
 
 # [PowerShell](#tab/powershell)
 
 ```powershell
-[System.Environment]::SetEnvironmentVariable('AOAIEndpoint', 'REPLACE_WITH_YOUR_AOAI_ENDPOINT_VALUE_HERE', 'User')
+[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_AOAI_ENDPOINT_VALUE_HERE', 'User')
 ```
 
 ```powershell
-[System.Environment]::SetEnvironmentVariable('AOAIKey', 'REPLACE_WITH_YOUR_AOAI_KEY_VALUE_HERE', 'User')
+[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_API_KEY', 'REPLACE_WITH_YOUR_AOAI_KEY_VALUE_HERE', 'User')
 ```
 
 ```powershell
-[System.Environment]::SetEnvironmentVariable('AOAIDeploymentId', 'REPLACE_WITH_YOUR_AOAI_DEPLOYMENT_VALUE_HERE', 'User')
+[System.Environment]::SetEnvironmentVariable('AZURE_OPEN_AI_DEPLOYMENT_ID', 'REPLACE_WITH_YOUR_AOAI_DEPLOYMENT_VALUE_HERE', 'User')
 ```
 
 ```powershell
-[System.Environment]::SetEnvironmentVariable('SearchEndpoint', 'REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_VALUE_HERE', 'User')
+[System.Environment]::SetEnvironmentVariable('AZURE_AI_SEARCH_ENDPOINT', 'REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_VALUE_HERE', 'User')
 ```
 
 ```powershell
-[System.Environment]::SetEnvironmentVariable('SearchKey', 'REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_KEY_VALUE_HERE', 'User')
+[System.Environment]::SetEnvironmentVariable('AZURE_AI_SEARCH_API_KEY', 'REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_KEY_VALUE_HERE', 'User')
 ```
 
 ```powershell
-[System.Environment]::SetEnvironmentVariable('SearchIndex', 'REPLACE_WITH_YOUR_INDEX_NAME_HERE', 'User')
+[System.Environment]::SetEnvironmentVariable('AZURE_AI_SEARCH_INDEX', 'REPLACE_WITH_YOUR_INDEX_NAME_HERE', 'User')
 ```
 
 # [Bash](#tab/bash)
 
 ```Bash
-export AOAIEndpoint=REPLACE_WITH_YOUR_AOAI_ENDPOINT_VALUE_HERE
+export AZURE_OPENAI_ENDPOINT=REPLACE_WITH_YOUR_AOAI_ENDPOINT_VALUE_HERE
 ```
 ```Bash
-export AOAIKey=REPLACE_WITH_YOUR_AOAI_KEY_VALUE_HERE
+export AZURE_OPENAI_API_KEY=REPLACE_WITH_YOUR_AOAI_KEY_VALUE_HERE
 ```
 ```Bash
-export AOAIDeploymentId=REPLACE_WITH_YOUR_AOAI_DEPLOYMENT_VALUE_HERE
+export AZURE_OPEN_AI_DEPLOYMENT_ID=REPLACE_WITH_YOUR_AOAI_DEPLOYMENT_VALUE_HERE
 ```
 ```Bash
-export SearchEndpoint=REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_VALUE_HERE
+export AZURE_AI_SEARCH_ENDPOINT=REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_VALUE_HERE
 ```
 ```Bash
-export SearchKey=REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_KEY_VALUE_HERE
+export AZURE_AI_SEARCH_API_KEY=REPLACE_WITH_YOUR_AZURE_SEARCH_RESOURCE_KEY_VALUE_HERE
 ```
 ```Bash
-export SearchIndex=REPLACE_WITH_YOUR_INDEX_NAME_HERE
+export AZURE_AI_SEARCH_INDEX=REPLACE_WITH_YOUR_INDEX_NAME_HERE
 ```
 
 ---

articles/ai-services/openai/includes/use-your-data-dotnet.md

@@ -22,12 +22,12 @@ using Azure.AI.OpenAI;
 using System.Text.Json;
 using static System.Environment;
 
-string azureOpenAIEndpoint = GetEnvironmentVariable("AOAIEndpoint");
-string azureOpenAIKey = GetEnvironmentVariable("AOAIKey");
-string searchEndpoint = GetEnvironmentVariable("SearchEndpoint");
-string searchKey = GetEnvironmentVariable("SearchKey");
-string searchIndex = GetEnvironmentVariable("SearchIndex");
-string deploymentName = GetEnvironmentVariable("AOAIDeploymentId");
+string azureOpenAIEndpoint = GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT");
+string azureOpenAIKey = GetEnvironmentVariable("AZURE_OPENAI_API_KEY");
+string searchEndpoint = GetEnvironmentVariable("AZURE_AI_SEARCH_ENDPOINT");
+string searchKey = GetEnvironmentVariable("AZURE_AI_SEARCH_API_KEY");
+string searchIndex = GetEnvironmentVariable("AZURE_AI_SEARCH_INDEX");
+string deploymentName = GetEnvironmentVariable("AZURE_OPEN_AI_DEPLOYMENT_ID");
 
 
 var client = new OpenAIClient(new Uri(azureOpenAIEndpoint), new AzureKeyCredential(azureOpenAIKey));
@@ -128,12 +128,12 @@ using Azure.AI.OpenAI;
 using System.Text.Json;
 using static System.Environment;
 
-string azureOpenAIEndpoint = GetEnvironmentVariable("AOAIEndpoint");
-string azureOpenAIKey = GetEnvironmentVariable("AOAIKey");
-string searchEndpoint = GetEnvironmentVariable("SearchEndpoint");
-string searchKey = GetEnvironmentVariable("SearchKey");
-string searchIndex = GetEnvironmentVariable("SearchIndex");
-string deploymentName = GetEnvironmentVariable("AOAIDeploymentId");
+string azureOpenAIEndpoint = GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT");
+string azureOpenAIKey = GetEnvironmentVariable("AZURE_OPENAI_API_KEY");
+string searchEndpoint = GetEnvironmentVariable("AZURE_AI_SEARCH_ENDPOINT");
+string searchKey = GetEnvironmentVariable("AZURE_AI_SEARCH_API_KEY");
+string searchIndex = GetEnvironmentVariable("AZURE_AI_SEARCH_INDEX");
+string deploymentName = GetEnvironmentVariable("AZURE_OPEN_AI_DEPLOYMENT_ID");
 
 
 var client = new OpenAIClient(new Uri(azureOpenAIEndpoint), new AzureKeyCredential(azureOpenAIKey));

articles/ai-services/openai/includes/use-your-data-go.md

@@ -47,16 +47,16 @@ ms.date: 08/29/2023
    )
    
    func main() {
-   	azureOpenAIKey := os.Getenv("AOAIKey")
-   	modelDeploymentID := os.Getenv("AOAIDeploymentId")
+   	azureOpenAIKey := os.Getenv("AZURE_OPENAI_API_KEY")
+   	modelDeploymentID := os.Getenv("AZURE_OPEN_AI_DEPLOYMENT_ID")
    
    	// Ex: "https://<your-azure-openai-host>.openai.azure.com"
-   	azureOpenAIEndpoint := os.Getenv("AOAIEndpoint")
+   	azureOpenAIEndpoint := os.Getenv("AZURE_OPENAI_ENDPOINT")
    
    	// Azure AI Search configuration
-   	searchIndex := os.Getenv("SearchIndex")
-   	searchEndpoint := os.Getenv("SearchEndpoint")
-   	searchAPIKey := os.Getenv("SearchKey")
+   	searchIndex := os.Getenv("AZURE_AI_SEARCH_INDEX")
+   	searchEndpoint := os.Getenv("AZURE_AI_SEARCH_ENDPOINT")
+   	searchAPIKey := os.Getenv("AZURE_AI_SEARCH_API_KEY")
    
    	if azureOpenAIKey == "" || modelDeploymentID == "" || azureOpenAIEndpoint == "" || searchIndex == "" || searchEndpoint == "" || searchAPIKey == "" {
    		fmt.Fprintf(os.Stderr, "Skipping example, environment variables missing\n")

articles/ai-services/openai/includes/use-your-data-javascript.md

@@ -38,12 +38,12 @@ const { OpenAIClient } = require("@azure/openai");
 const { DefaultAzureCredential } = require("@azure/identity")
 
 // Set the Azure and AI Search values from environment variables
-const endpoint = process.env["AOAIEndpoint"];
-const azureApiKey = process.env["AOAIKey"];
-const searchEndpoint = process.env["SearchEndpoint"];
-const searchKey = process.env["SearchKey"];
-const searchIndex = process.env["SearchIndex"];
-const deploymentId = process.env["AOAIDeploymentId"];
+const endpoint = process.env["AZURE_OPENAI_ENDPOINT"];
+const azureApiKey = process.env["AZURE_OPENAI_API_KEY"];
+const searchEndpoint = process.env["AZURE_AI_SEARCH_ENDPOINT"];
+const searchKey = process.env["AZURE_AI_SEARCH_API_KEY"];
+const searchIndex = process.env["AZURE_AI_SEARCH_INDEX"];
+const deploymentId = process.env["AZURE_OPEN_AI_DEPLOYMENT_ID"];
 
 async function main() {
   console.log("== Chat Using Your Own Data Sample ==");