Merge pull request #235553 from jboback/EnvVariablesSummarization

Summarization Environment Variables

Author: Jill Grant

articles/cognitive-services/language-service/summarization/includes/quickstarts/csharp-sdk.md

@@ -37,6 +37,11 @@ Use this quickstart to create a text summarization application with the client l
 
 ## Setting up
 
+[!INCLUDE [Create environment variables](../../../includes/environment-variables.md)]
+
+> [!div class="nextstepaction"]
+> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CSHARP&Pillar=Language&Product=Summarization&Page=quickstart&Section=Create-environment-variables" target="_target">I ran into an issue</a>
+
 ### Create a new .NET Core application
 
 Using the Visual Studio IDE, create a new .NET Core console app. This will create a "Hello World" project with a single C# source file: *program.cs*.
@@ -56,7 +61,7 @@ Install the client library by right-clicking on the solution in the **Solution E
 
 ## Code example
 
-Copy the following code into your *program.cs* file. Remember to replace the `key` variable with the key for your resource, and replace the `endpoint` variable with the endpoint for your resource. Then run the code.  
+Copy the following code into your *program.cs* file. Then run the code.  
 
 [!INCLUDE [find the key and endpoint for a resource](../../../includes/find-azure-resource-info.md)]
 
@@ -73,8 +78,12 @@ namespace Example
 {
     class Program
     {
-        private static readonly AzureKeyCredential credentials = new AzureKeyCredential("replace-with-your-key-here");
-        private static readonly Uri endpoint = new Uri("replace-with-your-endpoint-here");
+        // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
+        static string languageKey = Environment.GetEnvironmentVariable("LANGUAGE_KEY");
+        static string languageEndpoint = Environment.GetEnvironmentVariable("LANGUAGE_ENDPOINT");
+
+        private static readonly AzureKeyCredential credentials = new AzureKeyCredential(languageKey);
+        private static readonly Uri endpoint = new Uri(languageEndpoint);
 
         // Example method for summarizing text
         static async Task TextSummarizationExample(TextAnalyticsClient client)

articles/cognitive-services/language-service/summarization/includes/quickstarts/java-sdk.md

@@ -46,9 +46,14 @@ Create a Maven project in your preferred IDE or development environment. Then ad
 > [!div class="nextstepaction"]
 > <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CSHARP&Pillar=Language&Product=Summarization&Page=quickstart&Section=Set-up-the-environment" target="_target">I ran into an issue</a>
 
+[!INCLUDE [Create environment variables](../../../includes/environment-variables.md)]
+
+> [!div class="nextstepaction"]
+> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=JAVA&Pillar=Language&Product=Summarization&Page=quickstart&Section=Create-environment-variables" target="_target">I ran into an issue</a>
+
 ## Code example
 
-Create a Java file named `Example.java`. Open the file and copy the below code. Remember to replace the `key` variable with the key for your resource, and replace the `endpoint` variable with the endpoint for your resource. Then run the code.  
+Create a Java file named `Example.java`. Open the file and copy the below code. Then run the code.  
 
 [!INCLUDE [find the key and endpoint for a resource](../../../includes/find-azure-resource-info.md)]
 
@@ -64,11 +69,12 @@ import com.azure.ai.textanalytics.util.*;
 
 public class Example {
 
-    private static String KEY = "replace-with-your-key-here";
-    private static String ENDPOINT = "replace-with-your-endpoint-here";
+    // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
+    private static String languageKey = System.getenv("LANGUAGE_KEY");
+    private static String languageEndpoint = System.getenv("LANGUAGE_ENDPOINT");
 
     public static void main(String[] args) {
-        TextAnalyticsClient client = authenticateClient(KEY, ENDPOINT);
+        TextAnalyticsClient client = authenticateClient(languageKey, languageEndpoint);
         summarizationExample(client);
     }
     // Method to authenticate the client object with your key and endpoint

articles/cognitive-services/language-service/summarization/includes/quickstarts/nodejs-sdk.md

@@ -29,6 +29,11 @@ Use this quickstart to create a text summarization application with the client l
 
 ## Setting up
 
+[!INCLUDE [Create environment variables](../../../includes/environment-variables.md)]
+
+> [!div class="nextstepaction"]
+> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=JAVASCRIPT&Pillar=Language&Product=Summarization&Page=quickstart&Section=Create-environment-variables" target="_target">I ran into an issue</a>
+
 ### Create a new Node.js application
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it. 
@@ -58,7 +63,7 @@ npm install --save @azure/[email protected]
 
 ## Code example 
 
-Open the file and copy the below code. Remember to replace the `key` variable with the key for your resource, and replace the `endpoint` variable with the endpoint for your resource. Then run the code.  
+Open the file and copy the below code. Then run the code.  
 
 [!INCLUDE [find the key and endpoint for a resource](../../../includes/find-azure-resource-info.md)]
 
@@ -75,9 +80,9 @@ const { AzureKeyCredential, TextAnalysisClient } = require("@azure/ai-language-t
 // Load the .env file if it exists
 require("dotenv").config();
 
-// You'll need to set these environment variables or edit the following values
-const endpoint = process.env["ENDPOINT"] || "<paste-your-endpoint-here>";
-const apiKey = process.env["LANGUAGE_API_KEY"] || "<paste-your-key-here>";
+// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
+const endpoint = process.env.LANGUAGE_ENDPOINT;
+const apiKey = process.env.LANGUAGE_KEY;
 
 const documents = [
   `

articles/cognitive-services/language-service/summarization/includes/quickstarts/python-sdk.md

@@ -33,10 +33,15 @@ Use this quickstart to create a text summarization application with the client l
 
 > [!div class="nextstepaction"]
 > <a href="> [!div class="nextstepaction"]
-> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=JAVASCRIPT&Pillar=Language&Product=Summarization&Page=quickstart&Section=Code-example" target="_target">I ran into an issue</a>" target="_target">I ran into an issue</a>
+> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=PYTHON&Pillar=Language&Product=Summarization&Page=quickstart&Section=Code-example" target="_target">I ran into an issue</a>" target="_target">I ran into an issue</a>
 
 ## Setting up
 
+[!INCLUDE [Create environment variables](../../../includes/environment-variables.md)]
+
+> [!div class="nextstepaction"]
+> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=PYTHON&Pillar=Language&Product=Summarization&Page=quickstart&Section=Create-environment-variables" target="_target">I ran into an issue</a>
+
 ### Install the client library
 
 After installing Python, you can install the client library with:
@@ -61,15 +66,16 @@ pip install azure-ai-language-conversations==1.1.0b3
 
 ## Code example
 
-Create a new Python file and copy the below code. Remember to replace the `key` variable with the key for your resource, and replace the `endpoint` variable with the endpoint for your resource. Then run the code.  
+Create a new Python file and copy the below code. Then run the code.  
 
 [!INCLUDE [find the key and endpoint for a resource](../../../includes/find-azure-resource-info.md)]
 
 # [Document summarization](#tab/document-summarization)
 
 ```python
-key = "paste-your-key-here"
-endpoint = "paste-your-endpoint-here"
+# This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
+key = os.environ.get('LANGUAGE_KEY')
+endpoint = os.environ.get('LANGUAGE_ENDPOINT')
 
 from azure.ai.textanalytics import TextAnalyticsClient
 from azure.core.credentials import AzureKeyCredential

articles/cognitive-services/language-service/summarization/includes/quickstarts/rest-api.md

@@ -34,12 +34,18 @@ Use this quickstart to send text summarization requests using the REST API. In t
 > [!div class="nextstepaction"]
 > <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST API&Pillar=Language&Product=Summarization&Page=quickstart&Section=Prerequisites" target="_target">I ran into an issue</a>
 
+## Setting up
+
+[!INCLUDE [Create environment variables](../../../includes/environment-variables.md)]
+
+> [!div class="nextstepaction"]
+> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST API&Pillar=Language&Product=Summarization&Page=quickstart&Section=Create-environment-variables" target="_target">I ran into an issue</a>
+
 ## Example request
 
 > [!NOTE]
 > * The following BASH examples use the `\` line continuation character. If your console or terminal uses a different line continuation character, use that character.
 > * You can find language specific samples on [GitHub](https://github.com/Azure-Samples/cognitive-services-quickstart-code).
-> * Go to the Azure portal and find the key and endpoint for the Language resource you created in the prerequisites. They will be located on the resource's **key and endpoint** page, under **resource management**. Then replace the strings in the code below with your key and endpoint.
 To call the API, you need the following information:
 
 Choose the type of summarization you would like to perform, and select one of the tabs below to see an example API call:
@@ -60,7 +66,7 @@ Choose the type of summarization you would like to perform, and select one of th
 |`-H "Ocp-Apim-Subscription-Key:<key>`    | Specifies the key for accessing the API.        |
 |`-d <documents>`     | The JSON containing the documents you want to send.         |
 
-The following cURL commands are executed from a BASH shell. Edit these commands with your own resource name, resource key, and JSON values.
+The following cURL commands are executed from a BASH shell. Edit these commands with your own JSON values.
 
 ## Document summarization
 
@@ -71,9 +77,9 @@ The following example will get you started with document extractive summarizatio
 1. Copy the command below into a text editor. The BASH example uses the `\` line continuation character. If your console or terminal uses a different line continuation character, use that character instead.
 
 ```bash
-curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/jobs?api-version=2022-10-01-preview \
+curl -i -X POST $LANGUAGE_ENDPOINT/language/analyze-text/jobs?api-version=2022-10-01-preview \
 -H "Content-Type: application/json" \
--H "Ocp-Apim-Subscription-Key: <your-language-resource-key>" \
+-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY" \
 -d \
 ' 
 {
@@ -99,26 +105,23 @@ curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/
 }
 '
 ```
-2. Make the following changes in the command where needed:
-- Replace the value `your-language-resource-key` with your key.
-- Replace the first part of the request URL `your-language-resource-endpoint` with your endpoint URL.
 
-3. Open a command prompt window (for example: BASH).
+2. Open a command prompt window (for example: BASH).
 
-4. Paste the command from the text editor into the command prompt window, then run the command.
+3. Paste the command from the text editor into the command prompt window, then run the command.
 
-5. Get the `operation-location` from the response header. The value will look similar to the following URL:
+4. Get the `operation-location` from the response header. The value will look similar to the following URL:
 
 ```http
 https://<your-language-resource-endpoint>/language/analyze-text/jobs/12345678-1234-1234-1234-12345678?api-version=2022-10-01-preview
 ```
 
-6. To get the results of the request, use the following cURL command. Be sure to replace `<my-job-id>` with the numerical ID value you received from the previous `operation-location` response header:
+5. To get the results of the request, use the following cURL command. Be sure to replace `<my-job-id>` with the numerical ID value you received from the previous `operation-location` response header:
 
 ```bash
-curl -X GET https://<your-language-resource-endpoint>/language/analyze-text/jobs/<my-job-id>?api-version=2022-10-01-preview \
+curl -X GET $LANGUAGE_ENDPOINT/language/analyze-text/jobs/<my-job-id>?api-version=2022-10-01-preview \
 -H "Content-Type: application/json" \
--H "Ocp-Apim-Subscription-Key: <your-language-resource-key>"
+-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY"
 ```
 
 > [!div class="nextstepaction"]
@@ -209,9 +212,9 @@ The following example will get you started with conversation issue and resolutio
 1. Copy the command below into a text editor. The BASH example uses the `\` line continuation character. If your console or terminal uses a different line continuation character, use that character instead.
 
 ```bash
-curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-conversations/jobs?api-version=2022-10-01-preview \
+curl -i -X POST $LANGUAGE_ENDPOINT/language/analyze-conversations/jobs?api-version=2022-10-01-preview \
 -H "Content-Type: application/json" \
--H "Ocp-Apim-Subscription-Key: <your-language-resource-key>" \
+-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY" \
 -d \
 ' 
 {
@@ -291,26 +294,22 @@ curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-conve
 ```
 Only the `resolution` aspect supports sentenceCount. If you do not specify the `sentenceCount` parameter, the model will determine the summary's length. Note that `sentenceCount` is just the approximation of sentence count of output summary, range 1 to 7.
 
-2. Make the following changes in the command where needed:
-- Replace the value `your-language-resource-key` with your key.
-- Replace the first part of the request URL `your-language-resource-endpoint` with your endpoint URL.
-
-3. Open a command prompt window (for example: BASH).
+2. Open a command prompt window (for example: BASH).
 
-4. Paste the command from the text editor into the command prompt window, then run the command.
+3. Paste the command from the text editor into the command prompt window, then run the command.
 
-5. Get the `operation-location` from the response header. The value will look similar to the following URL:
+4. Get the `operation-location` from the response header. The value will look similar to the following URL:
 
 ```http
 https://<your-language-resource-endpoint>/language/analyze-conversations/jobs/12345678-1234-1234-1234-12345678?api-version=2022-10-01-preview
 ```
 
-6. To get the results of the request, use the following cURL command. Be sure to replace `<my-job-id>` with the numerical ID value you received from the previous `operation-location` response header:
+5. To get the results of the request, use the following cURL command. Be sure to replace `<my-job-id>` with the numerical ID value you received from the previous `operation-location` response header:
 
 ```bash
-curl -X GET https://<your-language-resource-endpoint>/language/analyze-conversations/jobs/<my-job-id>?api-version=2022-10-01-preview \
+curl -X GET $LANGUAGE_ENDPOINT/language/analyze-conversations/jobs/<my-job-id>?api-version=2022-10-01-preview \
 -H "Content-Type: application/json" \
--H "Ocp-Apim-Subscription-Key: <your-language-resource-key>"
+-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY"
 ```
 
 > [!div class="nextstepaction"]