openai

eric-urban · eric-urban · commit 98969f39bfd5 · 2024-08-14T10:12:43.000-07:00
diff --git a/articles/ai-services/openai/how-to/migration-javascript.md b/articles/ai-services/openai/how-to/migration-javascript.md
@@ -52,6 +52,8 @@ const apiKey = new AzureKeyCredential("your API key");
 
 Authenticating `AzureOpenAI` with an API key involves setting the `AZURE_OPENAI_API_KEY` environment variable or setting the `apiKey` string property in the options object when creating the `AzureOpenAI` client.
 
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 ## Constructing the client
 
 # [OpenAI JavaScript (new)](#tab/javascript-new)
diff --git a/articles/ai-services/openai/how-to/switching-endpoints.yml b/articles/ai-services/openai/how-to/switching-endpoints.yml
@@ -23,7 +23,7 @@ procedureSection:
   - title: |
       Authentication
     summary: |
-      We recommend using environment variables. If you haven't done this before, our [Python quickstarts](../quickstart.md) walks you through this configuration.
+      We recommend using Microsoft Entra ID or Azure Key Vault. You can use environment variables for testing outside of your production environment. If you haven't done this before, our [Python quickstarts](../quickstart.md) walks you through this configuration.
     
       ### API key
     code: |
diff --git a/articles/ai-services/openai/how-to/use-web-app.md b/articles/ai-services/openai/how-to/use-web-app.md
@@ -90,7 +90,6 @@ To enable Microsoft Entra ID for intra-service authentication for your web app,
 
 You can enable managed identity for the Azure OpenAI resource and the Azure App Service by navigating to "Identity" and turning on the system assigned managed identity in the Azure portal for each resource.
 
-
 :::image type="content" source="../media/use-your-data/openai-managed-identity.png" alt-text="Screenshot that shows the application identity configuration in the Azure portal." lightbox="../media/use-your-data/openai-managed-identity.png":::
 
 > [!NOTE]
diff --git a/articles/ai-services/openai/includes/assistants-javascript.md b/articles/ai-services/openai/includes/assistants-javascript.md
@@ -58,16 +58,12 @@ Go to your resource in the Azure portal. The **Keys and Endpoint** can be found
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview blade for an OpenAI Resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
 
-Create and assign persistent environment variables for your key and endpoint.
-
 [!INCLUDE [environment-variables](environment-variables.md)]
 
 Add additional environment variables for the deployment name and API version: 
 * `AZURE_OPENAI_DEPLOYMENT_NAME`: Your deployment name as shown in the Azure portal.
 * `OPENAI_API_VERSION`: Learn more about [API Versions](/azure/ai-services/openai/concepts/model-versions).
 
-Create and assign persistent environment variables for your key and endpoint.
-
 # [Command Line](#tab/command-line)
 
 ```cmd
diff --git a/articles/ai-services/openai/includes/assistants-python.md b/articles/ai-services/openai/includes/assistants-python.md
@@ -63,8 +63,6 @@ Go to your resource in the Azure portal. The **Keys and Endpoint** can be found
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview blade for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
 
-Create and assign persistent environment variables for your key and endpoint.
-
 [!INCLUDE [environment-variables](environment-variables.md)]
 
 ## Create an assistant
diff --git a/articles/ai-services/openai/includes/assistants-rest.md b/articles/ai-services/openai/includes/assistants-rest.md
@@ -35,8 +35,6 @@ Go to your resource in the Azure portal. The **Endpoint and Keys** can be found
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview blade for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
 
-Create and assign persistent environment variables for your key and endpoint.
-
 [!INCLUDE [environment-variables](environment-variables.md)]
 
 ## REST API
diff --git a/articles/ai-services/openai/includes/batch/batch-python.md b/articles/ai-services/openai/includes/batch/batch-python.md
@@ -69,6 +69,8 @@ For this article we'll create a file named `test.jsonl` and will copy the conten
 
 Once your input file is prepared, you first need to upload the file to then be able to kick off a batch job. File upload can be done both programmatically or via the Studio. This example uses environment variables in place of the key and endpoint values. If you're unfamiliar with using environment variables with Python refer to one of our [quickstarts](../../chatgpt-quickstart.md) where the process of setting up the environment variables in explained step-by-step.
 
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 ```python
 import os
 from openai import AzureOpenAI
diff --git a/articles/ai-services/openai/includes/batch/batch-rest.md b/articles/ai-services/openai/includes/batch/batch-rest.md
@@ -58,6 +58,8 @@ For this article we'll create a file named `test.jsonl` and will copy the conten
 
 Once your input file is prepared, you first need to upload the file to then be able to kick off a batch job. File upload can be done both programmatically or via the Studio. This example uses environment variables in place of the key and endpoint values. If you're unfamiliar with using environment variables with Python refer to one of our [quickstarts](../../chatgpt-quickstart.md) where the process of setting up the environment variables in explained step-by-step. 
 
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 ```http
 curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files?api-version=2024-07-01-preview \
   -H "Content-Type: multipart/form-data" \
diff --git a/articles/ai-services/openai/includes/chatgpt-powershell.md b/articles/ai-services/openai/includes/chatgpt-powershell.md
@@ -27,15 +27,17 @@ To successfully make a call against Azure OpenAI, you'll need an **endpoint** an
 | Variable name | Value                                                                                                                                                                                                                                                                                    |
 | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `ENDPOINT`    | This value can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. Alternatively, you can find the value in the **Azure OpenAI Studio** > **Playground** > **Code View**. An example endpoint is: `https://docs-test-001.openai.azure.com/`. |
-| `API-KEY`     | This value can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.                                                                                                                                      |
+| `API-KEY`     | This value can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`. |
 
 Go to your resource in the Azure portal. The **Endpoint and Keys** can be found in the **Resource Management** section. Copy your endpoint and access key as you'll need both for authenticating your API calls. You can use either `KEY1` or `KEY2`. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption.
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview UI for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
 
+### Environment variables
+
 Create and assign persistent environment variables for your key and endpoint.
 
-### Environment variables
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
 
 # [PowerShell](#tab/powershell)
 
diff --git a/articles/ai-services/openai/includes/dall-e-python.md b/articles/ai-services/openai/includes/dall-e-python.md
@@ -48,12 +48,8 @@ Go to your resource in the Azure portal. On the navigation pane, select **Keys a
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot that shows the Keys and Endpoint page for an Azure OpenAI resource in the Azure portal." lightbox="../media/quickstarts/endpoint.png":::
 
-Create and assign persistent environment variables for your key and endpoint.
-
 [!INCLUDE [environment-variables](environment-variables.md)]
 
-
-
 ## Install the Python SDK
 
 
diff --git a/articles/ai-services/openai/includes/embeddings-powershell.md b/articles/ai-services/openai/includes/embeddings-powershell.md
@@ -23,9 +23,11 @@ ms.author: mbullwin
 
 [!INCLUDE [get-key-endpoint](../includes/get-key-endpoint.md)]
 
+### Environment variables
+
 Create and assign persistent environment variables for your key and endpoint.
 
-### Environment variables
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
 
 # [Command Line](#tab/command-line)
 
diff --git a/articles/ai-services/openai/includes/embeddings-python.md b/articles/ai-services/openai/includes/embeddings-python.md
@@ -55,6 +55,10 @@ curl "https://raw.githubusercontent.com/Azure-Samples/Azure-OpenAI-Docs-Samples/
 
 ### Environment variables
 
+Create and assign persistent environment variables for your key and endpoint.
+
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 # [Command Line](#tab/command-line)
 
 ```CMD
diff --git a/articles/ai-services/openai/includes/environment-variables.md b/articles/ai-services/openai/includes/environment-variables.md
@@ -14,6 +14,8 @@ ms.date: 08/28/2023
 
 Create and assign persistent environment variables for your key and endpoint.
 
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 # [Command Line](#tab/command-line)
 
 ```cmd
diff --git a/articles/ai-services/openai/includes/fine-tuning-python.md b/articles/ai-services/openai/includes/fine-tuning-python.md
@@ -393,10 +393,10 @@ Unlike the previous SDK commands, deployment must be done using the control plan
 
 |variable      | Definition|
 |--------------|-----------|
-| token        | There are multiple ways to generate an authorization token. The easiest method for initial testing is to launch the Cloud Shell from the [Azure portal](https://portal.azure.com). Then run [`az account get-access-token`](/cli/azure/account#az-account-get-access-token()). You can use this token as your temporary authorization token for API testing. We recommend storing this in a new environment variable|
-| subscription | The subscription ID for the associated Azure OpenAI resource |
-| resource_group | The resource group name for your Azure OpenAI resource |
-| resource_name | The Azure OpenAI resource name |
+| token        | There are multiple ways to generate an authorization token. The easiest method for initial testing is to launch the Cloud Shell from the [Azure portal](https://portal.azure.com). Then run [`az account get-access-token`](/cli/azure/account#az-account-get-access-token()). You can use this token as your temporary authorization token for API testing. We recommend storing this in a new environment variable. |
+| subscription | The subscription ID for the associated Azure OpenAI resource. |
+| resource_group | The resource group name for your Azure OpenAI resource. |
+| resource_name | The Azure OpenAI resource name. |
 | model_deployment_name | The custom name for your new fine-tuned model deployment. This is the name that will be referenced in your code when making chat completion calls. |
 | fine_tuned_model | Retrieve this value from your fine-tuning job results in the previous step. It will look like `gpt-35-turbo-0613.ft-b044a9d3cf9c4228b5d393567f693b83`. You will need to add that value to the deploy_data json. Alternatively you can also deploy a checkpoint, by passing the checkpoint ID which will appear in the format `ftchkpt-e559c011ecc04fc68eaa339d8227d02d` |
 
diff --git a/articles/ai-services/openai/includes/fine-tuning-rest.md b/articles/ai-services/openai/includes/fine-tuning-rest.md
@@ -260,10 +260,10 @@ The following Python example shows how to use the REST API to create a model dep
 
 |variable      | Definition|
 |--------------|-----------|
-| token        | There are multiple ways to generate an authorization token. The easiest method for initial testing is to launch the Cloud Shell from the [Azure portal](https://portal.azure.com). Then run [`az account get-access-token`](/cli/azure/account#az-account-get-access-token()). You can use this token as your temporary authorization token for API testing. We recommend storing this in a new environment variable|
-| subscription | The subscription ID for the associated Azure OpenAI resource |
-| resource_group | The resource group name for your Azure OpenAI resource |
-| resource_name | The Azure OpenAI resource name |
+| token        | There are multiple ways to generate an authorization token. The easiest method for initial testing is to launch the Cloud Shell from the [Azure portal](https://portal.azure.com). Then run [`az account get-access-token`](/cli/azure/account#az-account-get-access-token()). You can use this token as your temporary authorization token for API testing. We recommend storing this in a new environment variable. |
+| subscription | The subscription ID for the associated Azure OpenAI resource. |
+| resource_group | The resource group name for your Azure OpenAI resource. |
+| resource_name | The Azure OpenAI resource name. |
 | model_deployment_name | The custom name for your new fine-tuned model deployment. This is the name that will be referenced in your code when making chat completion calls. |
 | fine_tuned_model | Retrieve this value from your fine-tuning job results in the previous step. It will look like `gpt-35-turbo-0613.ft-b044a9d3cf9c4228b5d393567f693b83`. You'll need to add that value to the deploy_data json. Alternatively you can also deploy a checkpoint, by passing the checkpoint ID which will appear in the format `ftchkpt-e559c011ecc04fc68eaa339d8227d02d` |
 
diff --git a/articles/ai-services/openai/includes/powershell.md b/articles/ai-services/openai/includes/powershell.md
@@ -32,9 +32,11 @@ Go to your resource in the Azure portal. The **Endpoint and Keys** can be found
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview blade for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
 
+### Environment variables
+
 Create and assign persistent environment variables for your key and endpoint.
 
-### Environment variables
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
 
 # [PowerShell](#tab/powershell)
 
diff --git a/articles/ai-services/openai/includes/python.md b/articles/ai-services/openai/includes/python.md
@@ -58,11 +58,8 @@ Go to your resource in the Azure portal. The **Keys and Endpoint** can be found
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview blade for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
 
-Create and assign persistent environment variables for your key and endpoint.
-
 [!INCLUDE [environment-variables](environment-variables.md)]
 
-
 > [!div class="nextstepaction"]
 > [I ran into an issue with the setup.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=PYTHON&Pillar=AOAI&Product=gpt&Page=quickstart&Section=Set-up)
 
diff --git a/articles/ai-services/openai/includes/rest.md b/articles/ai-services/openai/includes/rest.md
@@ -32,11 +32,8 @@ Go to your resource in the Azure portal. The **Endpoint and Keys** can be found
 
 :::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview blade for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
 
-Create and assign persistent environment variables for your key and endpoint.
-
 [!INCLUDE [environment-variables](environment-variables.md)]
 
-
 > [!div class="nextstepaction"]
 > [I ran into an issue with the setup.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=AOAI&Product=gpt&Page=quickstart&Section=Set-up)
 
diff --git a/articles/ai-services/openai/includes/spring-environment-variables.md b/articles/ai-services/openai/includes/spring-environment-variables.md
@@ -15,6 +15,8 @@ ms.date: 11/27/2023
 
 Create and assign persistent environment variables for your key and endpoint.
 
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 > [!NOTE]
 > Spring AI defaults the model name to `gpt-35-turbo`. It's only necessary to provide the `SPRING_AI_AZURE_OPENAI_MODEL` value if you've deployed a model with a different name.
 
diff --git a/articles/ai-services/openai/includes/use-your-data-common-variables.md b/articles/ai-services/openai/includes/use-your-data-common-variables.md
@@ -23,6 +23,10 @@ To successfully make a call against Azure OpenAI, you need the following variabl
 
 ### Environment variables
 
+Create and assign persistent environment variables for your key and endpoint.
+
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 # [Command Line](#tab/command-line)
 
 ```CMD
diff --git a/articles/ai-services/openai/includes/use-your-data-spring-common-variables.md b/articles/ai-services/openai/includes/use-your-data-spring-common-variables.md
@@ -23,6 +23,10 @@ To successfully make a call against Azure OpenAI, you need the following variabl
 
 ### Environment variables
 
+Create and assign persistent environment variables for your key and endpoint.
+
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 > [!NOTE]
 > Spring AI defaults the model name to `gpt-35-turbo`. It's only necessary to provide the `SPRING_AI_AZURE_OPENAI_MODEL` value if you've deployed a model with a different name.
 
diff --git a/articles/ai-services/openai/text-to-speech-quickstart.md b/articles/ai-services/openai/text-to-speech-quickstart.md
@@ -38,9 +38,11 @@ Go to your resource in the Azure portal. The **Endpoint and Keys** can be found
 
 :::image type="content" source="media/quickstarts/endpoint.png" alt-text="Screenshot of the overview UI for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location highlighted." lightbox="media/quickstarts/endpoint.png":::
 
+### Environment variables
+
 Create and assign persistent environment variables for your key and endpoint.
 
-### Environment variables
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
 
 # [Command Line](#tab/command-line)
 
diff --git a/articles/ai-services/openai/tutorials/fine-tune.md b/articles/ai-services/openai/tutorials/fine-tune.md
@@ -69,6 +69,10 @@ pip install "openai==0.28.1" requests tiktoken numpy
 
 ### Environment variables
 
+Create and assign persistent environment variables for your key and endpoint.
+
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 # [Command Line](#tab/command-line)
 
 ```CMD
diff --git a/articles/ai-services/openai/whisper-quickstart.md b/articles/ai-services/openai/whisper-quickstart.md
@@ -40,9 +40,11 @@ Go to your resource in the Azure portal. The **Endpoint and Keys** can be found
 
 :::image type="content" source="media/quickstarts/endpoint.png" alt-text="Screenshot of the overview UI for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="media/quickstarts/endpoint.png":::
 
+### Environment variables
+
 Create and assign persistent environment variables for your key and endpoint.
 
-### Environment variables
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
 
 # [Command Line](#tab/command-line)
 
