basic pivot framework to add custom speech in foundry portal

eric-urban · eric-urban · commit 0510db0987ec · 2025-02-25T05:19:31.000-08:00
diff --git a/articles/ai-services/speech-service/how-to-custom-speech-create-project.md b/articles/ai-services/speech-service/how-to-custom-speech-create-project.md
@@ -8,7 +8,7 @@ ms.service: azure-ai-speech
 ms.topic: how-to
 ms.date: 9/19/2024
 ms.author: eur
-zone_pivot_groups: speech-studio-cli-rest
+zone_pivot_groups: foundry-speech-studio
 #Customer intent: As a developer, I want to learn how to create a project for custom speech so that I can train and deploy a custom model.
 ---
 
@@ -35,52 +35,9 @@ Select the new project by name or select **Go to project**. You'll see these men
 
 ::: zone-end
 
-::: zone pivot="speech-cli"
+::: zone pivot="ai-foundry-portal"
 
-To create a project, use the `spx csr project create` command. Construct the request parameters according to the following instructions:
 
-- Set the required `language` parameter. The locale of the project and the contained datasets should be the same. The locale can't be changed later. The Speech CLI `language` parameter corresponds to the `locale` property in the JSON request and response.
-- Set the required `name` parameter. This is the name that is displayed in the Speech Studio. The Speech CLI `name` parameter corresponds to the `displayName` property in the JSON request and response.
-
-Here's an example Speech CLI command that creates a project:
-
-```azurecli-interactive
-spx csr project create --api-version v3.2 --name "My Project" --description "My Project Description" --language "en-US"
-```
-
-You should receive a response body in the following format:
-
-```json
-{
-  "self": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/0198f569-cc11-4099-a0e8-9d55bc3d0c52",
-  "links": {
-    "evaluations": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/0198f569-cc11-4099-a0e8-9d55bc3d0c52/evaluations",
-    "datasets": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/0198f569-cc11-4099-a0e8-9d55bc3d0c52/datasets",
-    "models": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/0198f569-cc11-4099-a0e8-9d55bc3d0c52/models",
-    "endpoints": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/0198f569-cc11-4099-a0e8-9d55bc3d0c52/endpoints",
-    "transcriptions": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/0198f569-cc11-4099-a0e8-9d55bc3d0c52/transcriptions"
-  },
-  "properties": {
-    "datasetCount": 0,
-    "evaluationCount": 0,
-    "modelCount": 0,
-    "transcriptionCount": 0,
-    "endpointCount": 0
-  },
-  "createdDateTime": "2024-07-14T17:15:55Z",
-  "locale": "en-US",
-  "displayName": "My Project",
-  "description": "My Project Description"
-}
-```
-
-The top-level `self` property in the response body is the project's URI. Use this URI to get details about the project's evaluations, datasets, models, endpoints, and transcriptions. You also use this URI to update or delete a project.
-
-For Speech CLI help with projects, run the following command:
-
-```azurecli-interactive
-spx help csr project
-```
 
 ::: zone-end
 
diff --git a/articles/ai-services/speech-service/how-to-custom-speech-deploy-model.md b/articles/ai-services/speech-service/how-to-custom-speech-deploy-model.md
@@ -8,7 +8,7 @@ ms.service: azure-ai-speech
 ms.topic: how-to
 ms.date: 9/19/2024
 ms.author: eur
-zone_pivot_groups: speech-studio-cli-rest
+zone_pivot_groups: foundry-speech-studio-cli-rest
 #Customer intent: As a developer, I want to learn how to deploy a custom speech model so that I can use it in my applications.
 ---
 
@@ -26,6 +26,12 @@ You can deploy an endpoint for a base or custom model, and then [update](#change
 
 ## Add a deployment endpoint
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 To create a custom endpoint, follow these steps:
@@ -183,6 +189,12 @@ The top-level `self` property in the response body is the endpoint's URI. Use th
 
 An endpoint can be updated to use another model that was created by the same Speech resource. As previously mentioned, you must update the endpoint's model before the [model expires](./how-to-custom-speech-model-and-endpoint-lifecycle.md). 
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 To use a new model and redeploy the custom endpoint:
@@ -304,6 +316,12 @@ The redeployment takes several minutes to complete. In the meantime, your endpoi
 
 Logging data is available for export if you configured it while creating the endpoint. 
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 To download the endpoint logs:
diff --git a/articles/ai-services/speech-service/how-to-custom-speech-evaluate-data.md b/articles/ai-services/speech-service/how-to-custom-speech-evaluate-data.md
@@ -8,7 +8,7 @@ ms.service: azure-ai-speech
 ms.topic: how-to
 ms.date: 9/19/2024
 ms.author: eur
-zone_pivot_groups: speech-studio-cli-rest
+zone_pivot_groups: foundry-speech-studio-cli-rest
 show_latex: true
 no-loc: [$$, '\times', '\over']
 #Customer intent: As a developer, I want to test the accuracy of a custom speech model so that I can evaluate whether it meets my requirements.
@@ -24,6 +24,12 @@ In this article, you learn how to quantitatively measure and improve the accurac
 
 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.
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 Follow these steps to create a test:
@@ -227,6 +233,12 @@ The top-level `self` property in the response body is the evaluation's URI. Use
 
 You should get the test results and [evaluate](#evaluate-word-error-rate-wer) the word error rate (WER) compared to speech recognition results.
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 Follow these steps to get test results:
diff --git a/articles/ai-services/speech-service/how-to-custom-speech-inspect-data.md b/articles/ai-services/speech-service/how-to-custom-speech-inspect-data.md
@@ -8,7 +8,7 @@ ms.service: azure-ai-speech
 ms.topic: how-to
 ms.date: 9/19/2024
 ms.author: eur
-zone_pivot_groups: speech-studio-cli-rest
+zone_pivot_groups: foundry-speech-studio-cli-rest
 #Customer intent: As a developer, I want to test the recognition quality of a custom speech model so that I can determine if the provided recognition result is correct.
 ---
 
@@ -22,6 +22,12 @@ Side-by-side model testing is useful to validate which speech recognition model
 
 ## Create a test
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 Follow these instructions to create a test:
@@ -215,6 +221,12 @@ The top-level `self` property in the response body is the evaluation's URI. Use
 
 You should get the test results and [inspect](#compare-transcription-with-audio) the audio datasets compared to transcription results for each model.
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 Follow these steps to get test results:
@@ -486,6 +498,12 @@ You should receive a response body in the following format:
 
 You can inspect the transcription output by each model tested, against the audio input dataset. If you included two models in the test, you can compare their transcription quality side by side. 
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 To review the quality of transcriptions:
diff --git a/articles/ai-services/speech-service/how-to-custom-speech-model-and-endpoint-lifecycle.md b/articles/ai-services/speech-service/how-to-custom-speech-model-and-endpoint-lifecycle.md
@@ -9,7 +9,7 @@ ms.service: azure-ai-speech
 ms.topic: how-to
 ms.date: 9/19/2024
 ms.reviewer: heikora
-zone_pivot_groups: speech-studio-cli-rest
+zone_pivot_groups: foundry-speech-studio-cli-rest
 #Customer intent: As a developer, I want to understand the lifecycle of custom speech models and endpoints so that I can plan for the expiration of my models.
 ---
 
@@ -48,6 +48,12 @@ When a custom model or base model expires, it's no longer available for transcri
 
 ## Get base model expiration dates
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 The last date that you could use the base model for training was shown when you created the custom model. For more information, see [Train a custom speech model](how-to-custom-speech-train-model.md).
@@ -150,6 +156,12 @@ You should receive a response body in the following format:
 
 ## Get custom model expiration dates
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 Follow these instructions to get the transcription expiration date for a custom model:
diff --git a/articles/ai-services/speech-service/how-to-custom-speech-train-model.md b/articles/ai-services/speech-service/how-to-custom-speech-train-model.md
@@ -8,7 +8,7 @@ ms.service: azure-ai-speech
 ms.topic: how-to
 ms.date: 9/19/2024
 ms.author: eur
-zone_pivot_groups: speech-studio-cli-rest
+zone_pivot_groups: foundry-speech-studio-cli-rest
 #Customer intent: As a developer, I want to train a custom speech model to improve recognition accuracy for the Microsoft base model or a custom model.
 ---
 
@@ -30,6 +30,12 @@ You can use a custom model for a limited time after it was trained. You must per
 
 ## Create a model
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 After you upload [training datasets](./how-to-custom-speech-test-and-train.md), follow these instructions to start training your model:
@@ -223,6 +229,12 @@ The top-level `self` property in the response body is the model's URI. Use this
 
 You can copy a model to another project that uses the same locale. For example, after a model is trained with audio data in a [region](regions.md#regions) with dedicated hardware for training, you can copy it to an AI Services resource for Speech in another region as needed. 
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 Follow these instructions to copy a model to a project in another region:
@@ -305,6 +317,12 @@ You should receive a response body in the following format:
 
 Models might have been copied from one project using the Speech CLI or REST API, without being connected to another project. Connecting a model is a matter of updating the model with a reference to the project.
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 If you're prompted in Speech Studio, you can connect them by selecting the **Connect** button. 
diff --git a/articles/ai-services/speech-service/how-to-custom-speech-upload-data.md b/articles/ai-services/speech-service/how-to-custom-speech-upload-data.md
@@ -8,7 +8,7 @@ ms.service: azure-ai-speech
 ms.topic: how-to
 ms.date: 9/19/2024
 ms.author: eur
-zone_pivot_groups: speech-studio-cli-rest
+zone_pivot_groups: foundry-speech-studio-cli-rest
 #Customer intent: As a developer, I need to understand how to upload data to test or train a custom speech model so that I can improve the accuracy of speech recognition.
 ---
 
@@ -21,6 +21,12 @@ You need audio or text data for testing the accuracy of speech recognition or tr
 
 ## Upload datasets
 
+::: zone pivot="ai-foundry-portal"
+
+
+
+::: zone-end
+
 ::: zone pivot="speech-studio"
 
 To upload your own datasets in Speech Studio, follow these steps:
diff --git a/zone-pivots/zone-pivot-groups.yml b/zone-pivots/zone-pivot-groups.yml
@@ -468,17 +468,28 @@ groups:
     title: Java
   - id: programming-language-python
     title: Python
-- id: speech-studio-cli-rest
+- id: foundry-speech-studio-cli-rest
 # Owner: eur
   title: Programming languages
   prompt: Choose a tool or API
   pivots:
+  - id: ai-foundry-portal
+    title: Foundry portal
   - id: speech-studio
     title: Speech Studio
   - id: rest-api
     title: REST
   - id: speech-cli
     title: Speech CLI
+- id: foundry-speech-studio
+# Owner: eur
+  title: Programming languages
+  prompt: Choose a tool or API
+  pivots:
+  - id: ai-foundry-portal
+    title: Foundry portal
+  - id: speech-studio
+    title: Speech Studio
 - id: programming-languages-set-nineteen
   title: Programming languages
   prompt: Choose a programming language
