Merge pull request #265668 from TimShererWithAquent/us200722g

Freshness update: Azure AI Speech service

Author: JamesJBarnett

articles/ai-services/speech-service/includes/common/environment-variables-openai.md

@@ -2,16 +2,17 @@
 author: eric-urban
 ms.service: azure-ai-speech
 ms.topic: include
-ms.date: 02/28/2023
+ms.date: 02/08/2024
 ms.author: eur
 ---
 
-Your application must be authenticated to access Azure AI services resources. For production, use a secure way of storing and accessing your credentials. For example, after you [get a key](~/articles/ai-services/multi-service-resource.md?pivots=azportal#get-the-keys-for-your-resource) for your <a href="https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices"  title="Create a Speech resource"  target="_blank">Speech resource</a>, write it to a new environment variable on the local machine running the application.
+Your application must be authenticated to access Azure AI services resources. For production, use a secure way of storing and accessing your credentials. For example, after you [get a key](~/articles/ai-services/multi-service-resource.md?pivots=azportal#get-the-keys-for-your-resource) for your Speech resource, write it to a new environment variable on the local machine running the application.
 
 > [!TIP]
-> Don't include the key directly in your code, and never post it publicly. See the Azure AI services [security](../../../security-features.md) article for more authentication options like [Azure Key Vault](../../../use-key-vault.md). 
+> Don't include the key directly in your code, and never post it publicly. See [Azure AI services security](../../../security-features.md) for more authentication options like [Azure Key Vault](../../../use-key-vault.md). 
+
+To set the environment variables, open a console window, and follow the instructions for your operating system and development environment.
 
-To set the environment variables, open a console window, and follow the instructions for your operating system and development environment. 
 - To set the `OPEN_AI_KEY` environment variable, replace `your-openai-key` with one of the keys for your resource.
 - To set the `OPEN_AI_ENDPOINT` environment variable, replace `your-openai-endpoint` with one of the regions for your resource.
 - To set the `OPEN_AI_DEPLOYMENT_NAME` environment variable, replace `your-openai-deployment-name` with one of the regions for your resource.
@@ -23,15 +24,15 @@ To set the environment variables, open a console window, and follow the instruct
 ```console
 setx OPEN_AI_KEY your-openai-key
 setx OPEN_AI_ENDPOINT your-openai-endpoint
-setx OPEN_AI_DEPLOYMENT_NAME=your-openai-deployment-name
+setx OPEN_AI_DEPLOYMENT_NAME your-openai-deployment-name
 setx SPEECH_KEY your-speech-key
 setx SPEECH_REGION your-speech-region
 ```
 
 > [!NOTE]
-> If you only need to access the environment variable in the current running console, you can set the environment variable with `set` instead of `setx`.
+> If you only need to access the environment variable in the current running console, set the environment variable with `set` instead of `setx`.
 
-After you add the environment variables, you may need to restart any running programs that will need to read the environment variable, including the console window. For example, if you are using Visual Studio as your editor, restart Visual Studio before running the example.
+After you add the environment variables, you might need to restart any running programs that need to read the environment variable, including the console window. For example, if Visual Studio is your editor, restart Visual Studio before running the example.
 
 #### [Linux](#tab/linux)
 
@@ -46,10 +47,9 @@ export SPEECH_REGION=your-speech-region
 After you add the environment variables, run `source ~/.bashrc` from your console window to make the changes effective.
 
 #### [macOS](#tab/macos)
-
 ##### Bash
 
-Edit your .bash_profile, and add the environment variables:
+Edit your *.bash_profile*, and add the environment variables:
 
 ```bash
 export OPEN_AI_KEY=your-openai-key
@@ -63,11 +63,11 @@ After you add the environment variables, run `source ~/.bash_profile` from your
 
 ##### Xcode
 
-For iOS and macOS development, you set the environment variables in Xcode. For example, follow these steps to set the environment variable in Xcode 13.4.1.
+For iOS and macOS development, set the environment variables in Xcode. For example, follow these steps to set the environment variable in Xcode 13.4.1.
 
-1. Select **Product** > **Scheme** > **Edit scheme**
-1. Select **Arguments** on the **Run** (Debug Run) page
-1. Under **Environment Variables** select the plus (+) sign to add a new environment variable. 
+1. Select **Product** > **Scheme** > **Edit scheme**.
+1. Select **Arguments** on the **Run** (Debug Run) page.
+1. Under **Environment Variables** select the plus (+) sign to add a new environment variable.
 1. Enter `SPEECH_KEY` for the **Name** and enter your Speech resource key for the **Value**.
 
 Repeat the steps to set other required environment variables.

articles/ai-services/speech-service/includes/quickstarts/openai-speech/csharp.md

@@ -2,7 +2,7 @@
 author: eric-urban
 ms.service: azure-ai-speech
 ms.topic: include
-ms.date: 04/15/2022
+ms.date: 02/08/2024
 ms.author: eur
 ---
 
@@ -15,6 +15,7 @@ ms.author: eur
 [!INCLUDE [Prerequisites](../../common/azure-prerequisites-openai.md)]
 
 ## Set up the environment
+
 The Speech SDK is available as a [NuGet package](https://www.nuget.org/packages/Microsoft.CognitiveServices.Speech) and implements .NET Standard 2.0. You install the Speech SDK later in this guide, but first check the [SDK installation guide](../../../quickstarts/setup-platform.md?pivots=programming-language-csharp) for any more requirements.
 
 ### Set environment variables
@@ -27,19 +28,27 @@ This example requires environment variables named `OPEN_AI_KEY`, `OPEN_AI_ENDPOI
 
 Follow these steps to create a new console application.
 
-1. Open a command prompt where you want the new project, and create a console application with the .NET CLI. The `Program.cs` file should be created in the project directory.
+1. Open a command prompt window in the folder where you want the new project. Run this command to create a console application with the .NET CLI.
+
     ```dotnetcli
     dotnet new console
     ```
+
+    The command creates a *Program.cs* file in the project directory.
+
 1. Install the Speech SDK in your new project with the .NET CLI.
+
     ```dotnetcli
     dotnet add package Microsoft.CognitiveServices.Speech
     ```
+
 1. Install the Azure OpenAI SDK (prerelease) in your new project with the .NET CLI.
+
     ```dotnetcli
     dotnet add package Azure.AI.OpenAI --prerelease 
     ```
-1. Replace the contents of `Program.cs` with the following code. 
+
+1. Replace the contents of `Program.cs` with the following code.
 
     ```csharp
     using System.Text;
@@ -189,14 +198,14 @@ Follow these steps to create a new console application.
 
 1. To increase or decrease the number of tokens returned by Azure OpenAI, change the `MaxTokens` property in the `ChatCompletionsOptions` class instance. For more information tokens and cost implications, see [Azure OpenAI tokens](/azure/ai-services/openai/overview#tokens) and [Azure OpenAI pricing](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/).
 
-Run your new console application to start speech recognition from a microphone:
+1. Run your new console application to start speech recognition from a microphone:
 
-```console
-dotnet run
-```
+    ```console
+    dotnet run
+    ```
 
 > [!IMPORTANT]
-> Make sure that you set the `OPEN_AI_KEY`, `OPEN_AI_ENDPOINT`, `OPEN_AI_DEPLOYMENT_NAME`, `SPEECH_KEY` and `SPEECH_REGION` environment variables as described [previously](#set-environment-variables). If you don't set these variables, the sample will fail with an error message.
+> Make sure that you set the `OPEN_AI_KEY`, `OPEN_AI_ENDPOINT`, `OPEN_AI_DEPLOYMENT_NAME`, `SPEECH_KEY` and `SPEECH_REGION` [environment variables](#set-environment-variables) as described. If you don't set these variables, the sample will fail with an error message.
 
 Speak into your microphone when prompted. The console output includes the prompt for you to begin speaking, then your request as text, and then the response from Azure OpenAI as text. The response from Azure OpenAI should be converted from text to speech and then output to the default speaker.
 
@@ -216,12 +225,13 @@ PS C:\dev\openai\csharp>
 ```
 
 ## Remarks
-Now that you've completed the quickstart, here are some more considerations:
 
-- To change the speech recognition language, replace `en-US` with another [supported language](~/articles/ai-services/speech-service/language-support.md). For example, `es-ES` for Spanish (Spain). The default language is `en-US` if you don't specify a language. For details about how to identify one of multiple languages that might be spoken, see [language identification](~/articles/ai-services/speech-service/language-identification.md). 
+Here are some more considerations:
+
+- To change the speech recognition language, replace `en-US` with another [supported language](~/articles/ai-services/speech-service/language-support.md). For example, `es-ES` for Spanish (Spain). The default language is `en-US`. For details about how to identify one of multiple languages that might be spoken, see [language identification](~/articles/ai-services/speech-service/language-identification.md).
 - To change the voice that you hear, replace `en-US-JennyMultilingualNeural` with another [supported voice](~/articles/ai-services/speech-service/language-support.md#prebuilt-neural-voices). If the voice doesn't speak the language of the text returned from Azure OpenAI, the Speech service doesn't output synthesized audio.
-- To use a different [model](/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability), replace `gpt-35-turbo-instruct` with the ID of another [deployment](/azure/ai-services/openai/how-to/create-resource?pivots=web-portal#deploy-a-model). Keep in mind that the deployment ID isn't necessarily the same as the model name. You named your deployment when you created it in [Azure OpenAI Studio](https://oai.azure.com/).
-- Azure OpenAI also performs content moderation on the prompt inputs and generated outputs. The prompts or responses may be filtered if harmful content is detected. For more information, see the [content filtering](/azure/ai-services/openai/concepts/content-filter) article.
+- To use a different [model](/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability), replace `gpt-35-turbo-instruct` with the ID of another [deployment](/azure/ai-services/openai/how-to/create-resource?pivots=web-portal#deploy-a-model). The deployment ID isn't necessarily the same as the model name. You named your deployment when you created it in [Azure OpenAI Studio](https://oai.azure.com/).
+- Azure OpenAI also performs content moderation on the prompt inputs and generated outputs. The prompts or responses might be filtered if harmful content is detected. For more information, see the [content filtering](/azure/ai-services/openai/concepts/content-filter) article.
 
 ## Clean up resources
 

articles/ai-services/speech-service/includes/quickstarts/openai-speech/intro.md

@@ -2,18 +2,19 @@
 author: eric-urban
 ms.service: azure-ai-speech
 ms.topic: include
-ms.date: 02/28/2023
+ms.date: 02/08/2024
 ms.author: eur
 ---
 
-> [!IMPORTANT]
-> To complete the steps in this guide, access must be granted to Microsoft Azure OpenAI Service in the desired Azure subscription. Currently, access to this service is granted only by application. You can apply for access to Azure OpenAI by completing the form at [https://aka.ms/oai/access](https://aka.ms/oai/access).
-
-In this how-to guide, you can use [Azure AI Speech](../../../overview.md) to converse with [Azure OpenAI Service](/azure/ai-services/openai/overview). The text recognized by the Speech service is sent to Azure OpenAI. The text response from Azure OpenAI is then synthesized by the Speech service.
+In this how-to guide, you can use Azure AI Speech to converse with Azure OpenAI Service. The text recognized by the Speech service is sent to Azure OpenAI. The Speech service synthesizes speech from the text response from Azure OpenAI.
 
 Speak into the microphone to start a conversation with Azure OpenAI.
+
 - The Speech service recognizes your speech and converts it into text (speech to text).
 - Your request as text is sent to Azure OpenAI.
-- The Speech service text to speech (TTS) feature synthesizes the response from Azure OpenAI to the default speaker.
+- The Speech service text to speech feature synthesizes the response from Azure OpenAI to the default speaker.
 
 Although the experience of this example is a back-and-forth exchange, Azure OpenAI doesn't remember the context of your conversation.
+
+> [!IMPORTANT]
+> To complete the steps in this guide, you must have access to Microsoft Azure OpenAI Service in your Azure subscription. Currently, access to this service is granted only by application. Apply for access to Azure OpenAI by completing the form at [https://aka.ms/oai/access](https://aka.ms/oai/access).

articles/ai-services/speech-service/includes/quickstarts/openai-speech/python.md

@@ -2,7 +2,7 @@
 author: eric-urban
 ms.service: azure-ai-speech
 ms.topic: include
-ms.date: 03/07/2023
+ms.date: 02/08/2024
 ms.author: eur
 ---
 
@@ -16,13 +16,14 @@ ms.author: eur
 
 ## Set up the environment
 
-The Speech SDK for Python is available as a [Python Package Index (PyPI) module](https://pypi.org/project/azure-cognitiveservices-speech/). The Speech SDK for Python is compatible with Windows, Linux, and macOS. 
-- You must install the [Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019, and 2022](/cpp/windows/latest-supported-vc-redist?view=msvc-170&preserve-view=true) for your platform. Installing this package for the first time might require a restart.
+The Speech SDK for Python is available as a [Python Package Index (PyPI) module](https://pypi.org/project/azure-cognitiveservices-speech/). The Speech SDK for Python is compatible with Windows, Linux, and macOS.
+
+- Install the [Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019, and 2022](/cpp/windows/latest-supported-vc-redist?view=msvc-170&preserve-view=true) for your platform. Installing this package for the first time might require a restart.
 - On Linux, you must use the x64 target architecture.
 
-Install a version of [Python from 3.7 or later](https://www.python.org/downloads/). First check the [SDK installation guide](../../../quickstarts/setup-platform.md?pivots=programming-language-python) for any more requirements. 
+Install a version of [Python from 3.7 or later](https://www.python.org/downloads/). First check the [SDK installation guide](../../../quickstarts/setup-platform.md?pivots=programming-language-python) for any more requirements.
 
-Install the following Python libraries: `os`, `requests`, `json`
+Install the following Python libraries: `os`, `requests`, `json`.
 
 ### Set environment variables
 
@@ -34,19 +35,24 @@ This example requires environment variables named `OPEN_AI_KEY`, `OPEN_AI_ENDPOI
 
 Follow these steps to create a new console application.
 
-1. Open a command prompt where you want the new project, and create a new file named `openai-speech.py`.
+1. Open a command prompt window in the folder where you want the new project. Open a command prompt where you want the new project, and create a new file named `openai-speech.py`.
+
 1. Run this command to install the Speech SDK:  
+
     ```console
     pip install azure-cognitiveservices-speech
     ```
+
 1. Run this command to install the OpenAI SDK:  
+
     ```console
     pip install openai
     ```
+
     > [!NOTE]
-    > This library is maintained by OpenAI (not Microsoft Azure). Refer to the [release history](https://github.com/openai/openai-python/releases) or the [version.py commit history](https://github.com/openai/openai-python/commits/main/openai/version.py) to track the latest updates to the library.
+    > This library is maintained by OpenAI, not Microsoft Azure. Refer to the [release history](https://github.com/openai/openai-python/releases) or the [version.py commit history](https://github.com/openai/openai-python/commits/main/openai/version.py) to track the latest updates to the library.
 
-1. Copy the following code into `openai-speech.py`: 
+1. Create a file named *openai-speech.py*. Copy the following code into that file:
 
     ```Python
     import os
@@ -139,11 +145,11 @@ Follow these steps to create a new console application.
 
 1. To increase or decrease the number of tokens returned by Azure OpenAI, change the `max_tokens` parameter. For more information tokens and cost implications, see [Azure OpenAI tokens](/azure/ai-services/openai/overview#tokens) and [Azure OpenAI pricing](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/).
 
-Run your new console application to start speech recognition from a microphone:
+1. Run your new console application to start speech recognition from a microphone:
 
-```console
-python openai-speech.py
-```
+    ```console
+    python openai-speech.py
+    ```
 
 > [!IMPORTANT]
 > Make sure that you set the `OPEN_AI_KEY`, `OPEN_AI_ENDPOINT`, `OPEN_AI_DEPLOYMENT_NAME`, `SPEECH_KEY` and `SPEECH_REGION` environment variables as described [previously](#set-environment-variables). If you don't set these variables, the sample will fail with an error message.
@@ -166,12 +172,13 @@ PS C:\dev\openai\python>
 ```
 
 ## Remarks
-Now that you've completed the quickstart, here are some more considerations:
 
-- To change the speech recognition language, replace `en-US` with another [supported language](~/articles/ai-services/speech-service/language-support.md). For example, `es-ES` for Spanish (Spain). The default language is `en-US` if you don't specify a language. For details about how to identify one of multiple languages that might be spoken, see [language identification](~/articles/ai-services/speech-service/language-identification.md). 
+Here are some more considerations:
+
+- To change the speech recognition language, replace `en-US` with another [supported language](~/articles/ai-services/speech-service/language-support.md). For example, `es-ES` for Spanish (Spain). The default language is `en-US`. For details about how to identify one of multiple languages that might be spoken, see [language identification](~/articles/ai-services/speech-service/language-identification.md).
 - To change the voice that you hear, replace `en-US-JennyMultilingualNeural` with another [supported voice](~/articles/ai-services/speech-service/language-support.md#prebuilt-neural-voices). If the voice doesn't speak the language of the text returned from Azure OpenAI, the Speech service doesn't output synthesized audio.
 - To use a different [model](/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability), replace `gpt-35-turbo-instruct` with the ID of another [deployment](/azure/ai-services/openai/how-to/create-resource#deploy-a-model). Keep in mind that the deployment ID isn't necessarily the same as the model name. You named your deployment when you created it in [Azure OpenAI Studio](https://oai.azure.com/).
-- Azure OpenAI also performs content moderation on the prompt inputs and generated outputs. The prompts or responses may be filtered if harmful content is detected. For more information, see the [content filtering](/azure/ai-services/openai/concepts/content-filter) article.
+- Azure OpenAI also performs content moderation on the prompt inputs and generated outputs. The prompts or responses might be filtered if harmful content is detected. For more information, see the [content filtering](/azure/ai-services/openai/concepts/content-filter) article.
 
 ## Clean up resources