Merge pull request #6317 from eric-urban/eur/custom-speech-projects

custom speech projects and API clarifications

Author: JillGrant615

articles/ai-services/speech-service/batch-transcription-audio-data.md

@@ -167,7 +167,7 @@ Follow these steps to restrict access to the storage account.
 1. Go to the [Azure portal](https://portal.azure.com/) and sign in to your Azure account.
 1. Select the Storage account.
 1. In the **Settings** group in the left pane, select **Configuration**.
-1. Select **Disabled** for **Allow Blob public access**. 
+1. Select **Disabled** for **Allow Blob anonymous access**. 
 1. Select **Disabled** for **Allow storage account key access**
 1. Select **Save**.
 

articles/ai-services/speech-service/bring-your-own-storage-speech-resource.md

@@ -385,7 +385,7 @@ For example, you can allow traffic from selected public IP addresses and Azure V
 1. Go to the [Azure portal](https://portal.azure.com/) and sign in to your Azure account.
 1. Select the Storage account.
 1. In the *Settings* group in the left pane, select *Configuration*.
-1. Select *Disabled* for *Allow Blob public access*. 
+1. Select *Disabled* for *Allow Blob anonymous access*. 
 1. Select *Disabled* for *Allow storage account key access*
 1. Select *Save*.
 
@@ -427,7 +427,7 @@ These are the most restricted security settings possible for the text to speech
 1. Go to the [Azure portal](https://portal.azure.com/) and sign in to your Azure account.
 1. Select the Storage account.
 1. In the *Settings* group in the left pane, select *Configuration*.
-1. Select *Disabled* for *Allow Blob public access*. 
+1. Select *Disabled* for *Allow Blob anonymous access*. 
 1. Select *Disabled* for *Allow storage account key access*
 1. Select *Save*.
 

articles/ai-services/speech-service/how-to-audio-content-creation.md

@@ -141,7 +141,7 @@ After you review your audio output and are satisfied with your tuning and adjust
 
 If you lose access permission to your Bring Your Own Storage (BYOS), you can't view, create, edit, or delete files. To resume your access, you need to remove the current storage and reconfigure the BYOS in the [Azure portal](https://portal.azure.com/#allservices). To learn more about how to configure BYOS, see [Mount Azure Storage as a local share in App Service](/azure/app-service/configure-connect-to-azure-storage?pivots=container-linux&tabs=portal). 
 
-After configuring the BYOS permission, you need to configure anonymous public read access for related containers and blobs. Otherwise, blob data isn't available for public access and your lexicon file in the blob is inaccessible. By default, a container’s public access setting is disabled. To grant anonymous users read access to a container and its blobs, first set **Allow Blob public access** to **Enabled** to allow public access for the storage account, then set the container's (named **acc-public-files**) public access level (**anonymous read access for blobs only**). To learn more about how to configure anonymous public read access, see [Configure anonymous public read access for containers and blobs](/azure/storage/blobs/anonymous-read-access-configure?tabs=portal). 
+After configuring the BYOS permission, you need to configure anonymous public read access for related containers and blobs. Otherwise, blob data isn't available for public access and your lexicon file in the blob is inaccessible. By default, a container’s public access setting is disabled. To grant anonymous users read access to a container and its blobs, first set **Allow Blob anonymous access** to **Enabled** to allow public access for the storage account, then set the container's (named **acc-public-files**) public access level (**anonymous read access for blobs only**). To learn more about how to configure anonymous public read access, see [Configure anonymous public read access for containers and blobs](/azure/storage/blobs/anonymous-read-access-configure?tabs=portal). 
 
 ## Add or remove Audio Content Creation users
 

articles/ai-services/speech-service/how-to-custom-speech-create-project.md

@@ -16,6 +16,9 @@ zone_pivot_groups: foundry-speech-studio
 
 With custom speech, you can enhance speech recognition accuracy for your applications by using a custom model for real-time speech to text, speech translation, and batch transcription. 
 
+> [!TIP]
+> Bring your custom speech models from [Speech Studio](https://speech.microsoft.com) to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). In Azure AI Foundry portal, you can pick up where you left off by connecting to your existing Speech resource. For more information about connecting to an existing Speech resource, see [Connect to an existing Speech resource](../../ai-studio/ai-services/how-to/connect-ai-services.md#connect-azure-ai-services-after-you-create-a-project).
+
 You create a custom speech model by fine-tuning an Azure AI Speech base model with your own data. You can upload your data, test and train a custom model, compare accuracy between models, and deploy a model to a custom endpoint.
 
 This article shows you how to use fine-tuning to create a custom speech model. For more information about custom speech, see the [custom speech overview](./custom-speech-overview.md) documentation.
@@ -63,7 +66,7 @@ After fine-tuning, you can access your custom speech models and deployments from
 
 ::: zone pivot="speech-studio"
 
-To create a custom speech project in [Speech Studio](https://aka.ms/speechstudio/customspeech), follow these steps:
+After you create a custom speech project, you can access your custom speech models and deployments from the **Custom speech** page.
 
 1. Sign in to the [Speech Studio](https://aka.ms/speechstudio/customspeech).
 1. Select the subscription and Speech resource to work with. 
@@ -78,6 +81,46 @@ Select the new project by name or select **Go to project**. Then you should see
 
 ::: zone-end
 
+
+## Get the project ID for the REST API
+
+::: zone pivot="ai-foundry-portal"
+
+When you use the speech to text REST API for custom speech, you need to set the `project` property to the ID of your custom speech project. You need to set the `project` property so that you can manage fine-tuning in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). 
+
+> [!IMPORTANT]
+> The project ID for custom speech isn't the same as the ID of the Azure AI Foundry project.
+
+You can find the project ID in the URL after you select or start fine-tuning a custom speech model. 
+
+1. Sign in to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs).
+1. Select **Fine-tuning** from the left pane.
+1. Select **AI Service fine-tuning**.
+1. Select the custom model that you want to check from the **Model name** column.
+1. Inspect the URL in your browser. The project ID is part of the URL. For example, the project ID is `00001111-aaaa-2222-bbbb-3333cccc4444` in the following URL: 
+
+    ```https
+    https://ai.azure.com/build/models/aiservices/speech/customspeech/00001111-aaaa-2222-bbbb-3333cccc4444/<REDACTED_FOR_BREVITY>
+    ```
+
+::: zone-end
+
+::: zone pivot="speech-studio"
+
+When you use the speech to text REST API for custom speech, you need to set the `project` property to the ID of your custom speech project. You need to set the `project` property so that you can manage fine-tuning in the [Speech Studio](https://aka.ms/speechstudio/customspeech). 
+
+To get the project ID for a custom speech project in [Speech Studio](https://aka.ms/speechstudio/customspeech):
+
+1. Sign in to the [Speech Studio](https://aka.ms/speechstudio/customspeech) and select the **Custom speech** tile.
+1. Select your custom speech project. 
+1. Inspect the URL in your browser. The project ID is part of the URL. For example, the project ID is `00001111-aaaa-2222-bbbb-3333cccc4444` in the following URL:
+
+    ```https
+    https://speech.microsoft.com/portal/<Your-Resource-ID>/customspeech/00001111-aaaa-2222-bbbb-3333cccc4444
+    ```
+
+::: zone-end
+
 ## Related content
 
 * [Training and testing datasets](./how-to-custom-speech-test-and-train.md)

articles/ai-services/speech-service/how-to-custom-speech-deploy-model.md

@@ -26,6 +26,9 @@ You can deploy an endpoint for a base or custom model, and then [update](#change
 
 ## Add a deployment endpoint
 
+> [!TIP]
+> Bring your custom speech models from [Speech Studio](https://speech.microsoft.com) to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). In Azure AI Foundry portal, you can pick up where you left off by connecting to your existing Speech resource. For more information about connecting to an existing Speech resource, see [Connect to an existing Speech resource](../../ai-studio/ai-services/how-to/connect-ai-services.md#connect-azure-ai-services-after-you-create-a-project).
+
 ::: zone pivot="ai-foundry-portal"
 
 1. Sign in to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs).
@@ -80,9 +83,11 @@ Select the endpoint link to view information specific to it, such as the endpoin
 
 ::: zone pivot="speech-cli"
 
+Before proceeding, make sure that you have the [Speech CLI](./spx-basics.md) installed and configured.
+
 To create an endpoint and deploy a model, use the `spx csr endpoint create` command. Construct the request parameters according to the following instructions:
 
-- Set the `project` property to the ID of an existing project. This property is recommended so that you can also view and manage the endpoint in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). You can run the `spx csr project list` command to get available projects.
+- Set the `project` property to the ID of an existing project. The `project` property is recommended so that you can also manage fine-tuning for custom speech in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). To get the project ID, see [Get the project ID for the REST API](./how-to-custom-speech-create-project.md#get-the-project-id-for-the-rest-api) documentation.
 - Set the required `model` property to the ID of the model that you want deployed to the endpoint. 
 - Set the required `language` property. The endpoint locale must match the locale of the model. The locale can't be changed later. The Speech CLI `language` property corresponds to the `locale` property in the JSON request and response.
 - Set the required `name` property. This is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). The Speech CLI `name` property corresponds to the `displayName` property in the JSON request and response.
@@ -94,6 +99,9 @@ Here's an example Speech CLI command to create an endpoint and deploy a model:
 spx csr endpoint create --api-version v3.2 --project YourProjectId --model YourModelId --name "My Endpoint" --description "My Endpoint Description" --language "en-US"
 ```
 
+> [!IMPORTANT]
+> You must set `--api-version v3.2`. The Speech CLI uses the REST API, but doesn't yet support versions later than `v3.2`.
+
 You should receive a response body in the following format:
 
 ```json
@@ -140,7 +148,7 @@ spx help csr endpoint
 
 To create an endpoint and deploy a model, use the [Endpoints_Create](/rest/api/speechtotext/endpoints/create) operation of the [Speech to text REST API](rest-speech-to-text.md). Construct the request body according to the following instructions:
 
-- Set the `project` property to the URI of an existing project. This property is recommended so that you can also view and manage the endpoint in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
+- Set the `project` property to the URI of an existing project. This property is recommended so that you can also view and manage the endpoint in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). To get the project ID, see [Get the project ID for the REST API](./how-to-custom-speech-create-project.md#get-the-project-id-for-the-rest-api) documentation.
 - Set the required `model` property to the URI of the model that you want deployed to the endpoint. 
 - Set the required `locale` property. The endpoint locale must match the locale of the model. The locale can't be changed later.
 - Set the required `displayName` property. This is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs).
@@ -225,6 +233,8 @@ To use a new model and redeploy the custom endpoint:
 
 ::: zone pivot="speech-cli"
 
+Before proceeding, make sure that you have the [Speech CLI](./spx-basics.md) installed and configured.
+
 To redeploy the custom endpoint with a new model, use the `spx csr model update` command. Construct the request parameters according to the following instructions:
 
 - Set the required `endpoint` property to the ID of the endpoint that you want deployed.
@@ -236,6 +246,9 @@ Here's an example Speech CLI command that redeploys the custom endpoint with a n
 spx csr endpoint update --api-version v3.2 --endpoint YourEndpointId --model YourModelId
 ```
 
+> [!IMPORTANT]
+> You must set `--api-version v3.2`. The Speech CLI uses the REST API, but doesn't yet support versions later than `v3.2`.
+
 You should receive a response body in the following format:
 
 ```json
@@ -351,6 +364,8 @@ To download the endpoint logs:
 
 ::: zone pivot="speech-cli"
 
+Before proceeding, make sure that you have the [Speech CLI](./spx-basics.md) installed and configured.
+
 To get logs for an endpoint, use the `spx csr endpoint list` command. Construct the request parameters according to the following instructions:
 
 - Set the required `endpoint` property to the ID of the endpoint that you want to get logs.
@@ -361,6 +376,9 @@ Here's an example Speech CLI command that gets logs for an endpoint:
 spx csr endpoint list --api-version v3.2 --endpoint YourEndpointId
 ```
 
+> [!IMPORTANT]
+> You must set `--api-version v3.2`. The Speech CLI uses the REST API, but doesn't yet support versions later than `v3.2`.
+
 The locations of each log file with more details are returned in the response body.
 
 ::: zone-end

articles/ai-services/speech-service/how-to-custom-speech-evaluate-data.md

@@ -22,6 +22,9 @@ In this article, you learn how to quantitatively measure and improve the accurac
 
 ## Create a test
 
+> [!TIP]
+> Bring your custom speech models from [Speech Studio](https://speech.microsoft.com) to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). In Azure AI Foundry portal, you can pick up where you left off by connecting to your existing Speech resource. For more information about connecting to an existing Speech resource, see [Connect to an existing Speech resource](../../ai-studio/ai-services/how-to/connect-ai-services.md#connect-azure-ai-services-after-you-create-a-project).
+
 You can test the accuracy of your custom model by creating a test. A test requires a collection of audio files and their corresponding transcriptions. You can compare a custom model's accuracy with a speech to text base model or another custom model. After you [get](#get-test-results) the test results, [evaluate the word error rate (WER)](#evaluate-word-error-rate-wer) compared to speech recognition results.
 
 After you [upload training and testing datasets](how-to-custom-speech-upload-data.md), you can create a test.
@@ -74,9 +77,11 @@ Follow these steps to create an accuracy test:
 
 ::: zone pivot="speech-cli"
 
+Before proceeding, make sure that you have the [Speech CLI](./spx-basics.md) installed and configured.
+
 To create a test, use the `spx csr evaluation create` command. Construct the request parameters according to the following instructions:
 
-- Set the `project` property to the ID of an existing project. This property is recommended so that you can also view the test in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). You can run the `spx csr project list` command to get available projects.
+- Set the `project` property to the ID of an existing project. The `project` property is recommended so that you can also manage fine-tuning for custom speech in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). To get the project ID, see [Get the project ID for the REST API](./how-to-custom-speech-create-project.md#get-the-project-id-for-the-rest-api) documentation.
 - Set the required `model1` property to the ID of a model that you want to test.
 - Set the required `model2` property to the ID of another model that you want to test. If you don't want to compare two models, use the same model for both `model1` and `model2`.
 - Set the required `dataset` property to the ID of a dataset that you want to use for the test.
@@ -89,6 +94,9 @@ Here's an example Speech CLI command that creates a test:
 spx csr evaluation create --api-version v3.2 --project aaaabbbb-0000-cccc-1111-dddd2222eeee --dataset bbbbcccc-1111-dddd-2222-eeee3333ffff --model1 ccccdddd-2222-eeee-3333-ffff4444aaaa --model2 ddddeeee-3333-ffff-4444-aaaa5555bbbb --name "My Evaluation" --description "My Evaluation Description"
 ```
 
+> [!IMPORTANT]
+> You must set `--api-version v3.2`. The Speech CLI uses the REST API, but doesn't yet support versions later than `v3.2`.
+
 You should receive a response body in the following format:
 
 ```json
@@ -159,7 +167,7 @@ spx help csr evaluation
 
 To create a test, use the [Evaluations_Create](/rest/api/speechtotext/evaluations/create) operation of the [Speech to text REST API](rest-speech-to-text.md). Construct the request body according to the following instructions:
 
-- Set the `project` property to the URI of an existing project. This property is recommended so that you can also view the test in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
+- Set the `project` property to the ID of an existing project. The `project` property is recommended so that you can also manage fine-tuning for custom speech in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs). To get the project ID, see [Get the project ID for the REST API](./how-to-custom-speech-create-project.md#get-the-project-id-for-the-rest-api) documentation.
 - Set the `testingKind` property to `Evaluation` within `customProperties`. If you don't specify `Evaluation`, the test is treated as a quality inspection test. Whether the `testingKind` property is set to `Evaluation` or `Inspection`, or not set, you can access the accuracy scores via the API, but not in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs).
 - Set the required `model1` property to the URI of a model that you want to test.
 - Set the required `model2` property to the URI of another model that you want to test. If you don't want to compare two models, use the same model for both `model1` and `model2`.
@@ -277,6 +285,8 @@ This page lists all the utterances in your dataset and the recognition results,
 
 ::: zone pivot="speech-cli"
 
+Before proceeding, make sure that you have the [Speech CLI](./spx-basics.md) installed and configured.
+
 To get test results, use the `spx csr evaluation status` command. Construct the request parameters according to the following instructions:
 
 - Set the required `evaluation` property to the ID of the evaluation that you want to get test results.
@@ -287,6 +297,9 @@ Here's an example Speech CLI command that gets test results:
 spx csr evaluation status --api-version v3.2 --evaluation aaaabbbb-6666-cccc-7777-dddd8888eeee
 ```
 
+> [!IMPORTANT]
+> You must set `--api-version v3.2`. The Speech CLI uses the REST API, but doesn't yet support versions later than `v3.2`.
+
 The word error rates and more details are returned in the response body.
 
 You should receive a response body in the following format: