Skip to content

Commit 7df4ec5

Browse files
authored
Merge pull request #203216 from eric-urban/eur/try-it-user-research
cli try it interactive
2 parents 37a6076 + ae86b3b commit 7df4ec5

9 files changed

+116
-29
lines changed

articles/cognitive-services/Speech-Service/how-to-custom-speech-create-project.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ To create a Custom Speech project, follow these steps:
3030

3131
Select the new project by name or select **Go to project**. You will see these menu items in the left panel: **Speech datasets**, **Train custom models**, **Test models**, and **Deploy models**.
3232

33+
> [!div class="nextstepaction"]
34+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=Speech-studio&Pillar=Speech&Product=Custom-speech&Page=Create-a-project&Section=Create-a-project" target="_target">I ran into an issue</a>
35+
3336
::: zone-end
3437

3538
::: zone pivot="speech-cli"
@@ -41,10 +44,13 @@ To create a project, use the `spx csr project create` command. Construct the req
4144

4245
Here's an example Speech CLI command that creates a project:
4346

44-
```azurecli
47+
```azurecli-interactive
4548
spx csr project create --name "My Project" --description "My Project Description" --language "en-US"
4649
```
4750

51+
> [!div class="nextstepaction"]
52+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CLI&Pillar=Speech&Product=Custom-speech&Page=Create-a-project&Section=Create-a-project" target="_target">I ran into an issue</a>
53+
4854
You should receive a response body in the following format:
4955

5056
```json
@@ -75,7 +81,7 @@ The top-level `self` property in the response body is the project's URI. Use thi
7581

7682
For Speech CLI help with projects, run the following command:
7783

78-
```azurecli
84+
```azurecli-interactive
7985
spx help csr project
8086
```
8187

@@ -98,6 +104,9 @@ curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey" -H "Content-
98104
} ' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/projects"
99105
```
100106

107+
> [!div class="nextstepaction"]
108+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=Speech&Product=Custom-speech&Page=Create-a-project&Section=Create-a-project" target="_target">I ran into an issue</a>
109+
101110
You should receive a response body in the following format:
102111

103112
```json

articles/cognitive-services/Speech-Service/how-to-custom-speech-deploy-model.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,13 @@ To create an endpoint and deploy a model, use the `spx csr endpoint create` comm
6666

6767
Here's an example Speech CLI command to create an endpoint and deploy a model:
6868

69-
```azurecli
69+
```azurecli-interactive
7070
spx csr endpoint create --project YourProjectId --model YourModelId --name "My Endpoint" --description "My Endpoint Description" --language "en-US"
7171
```
7272

73+
> [!div class="nextstepaction"]
74+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=Speech-studio&Pillar=Speech&Product=Custom-speech&Page=Deploy-a-model&Section=Add-a-deployment-endpoint" target="_target">I ran into an issue</a>
75+
7376
You should receive a response body in the following format:
7477

7578
```json
@@ -106,7 +109,7 @@ The top-level `self` property in the response body is the endpoint's URI. Use th
106109

107110
For Speech CLI help with endpoints, run the following command:
108111

109-
```azurecli
112+
```azurecli-interactive
110113
spx help csr endpoint
111114
```
112115

@@ -141,6 +144,9 @@ curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey" -H "Content-
141144
}' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints"
142145
```
143146

147+
> [!div class="nextstepaction"]
148+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CLI&Pillar=Speech&Product=Custom-speech&Page=Deploy-a-model&Section=Add-a-deployment-endpoint" target="_target">I ran into an issue</a>
149+
144150
You should receive a response body in the following format:
145151

146152
```json
@@ -202,10 +208,13 @@ To redeploy the custom endpoint with a new model, use the `spx csr model update`
202208

203209
Here's an example Speech CLI command that redeploys the custom endpoint with a new model:
204210

205-
```azurecli
211+
```azurecli-interactive
206212
spx csr endpoint update --endpoint YourEndpointId --model YourModelId
207213
```
208214

215+
> [!div class="nextstepaction"]
216+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=Speech&Product=Custom-speech&Page=Deploy-a-model&Section=Add-a-deployment-endpoint" target="_target">I ran into an issue</a>
217+
209218
You should receive a response body in the following format:
210219

211220
```json
@@ -240,7 +249,7 @@ You should receive a response body in the following format:
240249

241250
For Speech CLI help with endpoints, run the following command:
242251

243-
```azurecli
252+
```azurecli-interactive
244253
spx help csr endpoint
245254
```
246255

@@ -262,6 +271,9 @@ curl -v -X PATCH -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey" -H "Content
262271
}' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/YourEndpointId"
263272
```
264273

274+
> [!div class="nextstepaction"]
275+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=Speech-studio&Pillar=Speech&Product=Custom-speech&Page=Deploy-a-model&Section=Change-model-and-redeploy-endpoint" target="_target">I ran into an issue</a>
276+
265277
You should receive a response body in the following format:
266278

267279
```json
@@ -321,10 +333,13 @@ To gets logs for an endpoint, use the `spx csr endpoint list` command. Construct
321333

322334
Here's an example Speech CLI command that gets logs for an endpoint:
323335

324-
```azurecli
336+
```azurecli-interactive
325337
spx csr endpoint list --endpoint YourEndpointId
326338
```
327339

340+
> [!div class="nextstepaction"]
341+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CLI&Pillar=Speech&Product=Custom-speech&Page=Deploy-a-model&Section=Change-model-and-redeploy-endpoint" target="_target">I ran into an issue</a>
342+
328343
The location of each log file with more details are returned in the response body.
329344

330345
::: zone-end
@@ -339,6 +354,9 @@ Make an HTTP GET request using the URI as shown in the following example. Replac
339354
curl -v -X GET "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/YourEndpointId" -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey"
340355
```
341356

357+
> [!div class="nextstepaction"]
358+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=Speech&Product=Custom-speech&Page=Deploy-a-model&Section=Change-model-and-redeploy-endpoint" target="_target">I ran into an issue</a>
359+
342360
You should receive a response body in the following format:
343361

344362
```json

articles/cognitive-services/Speech-Service/how-to-custom-speech-evaluate-data.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Follow these steps to create a test:
4343
1. Enter the test name and description, and then select **Next**.
4444
1. Review the test details, and then select **Save and close**.
4545

46+
> [!div class="nextstepaction"]
47+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=Speech-studio&Pillar=Speech&Product=Custom-speech&Page=Test-model-quantitatively&Section=Create-a-test" target="_target">I ran into an issue</a>
4648
4749
::: zone-end
4850

@@ -59,10 +61,13 @@ To create a test, use the `spx csr evaluation create` command. Construct the req
5961

6062
Here's an example Speech CLI command that creates a test:
6163

62-
```azurecli
64+
```azurecli-interactive
6365
spx csr evaluation create --project 9f8c4cbb-f9a5-4ec1-8bb0-53cfa9221226 --dataset be378d9d-a9d7-4d4a-820a-e0432e8678c7 --model1 ff43e922-e3e6-4bf0-8473-55c08fd68048 --model2 1aae1070-7972-47e9-a977-87e3b05c457d --name "My Evaluation" --description "My Evaluation Description"
6466
```
6567

68+
> [!div class="nextstepaction"]
69+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CLI&Pillar=Speech&Product=Custom-speech&Page=Test-model-quantitatively&Section=Create-a-test" target="_target">I ran into an issue</a>
70+
6671
You should receive a response body in the following format:
6772

6873
```json
@@ -120,7 +125,7 @@ The top-level `self` property in the response body is the evaluation's URI. Use
120125

121126
For Speech CLI help with evaluations, run the following command:
122127

123-
```azurecli
128+
```azurecli-interactive
124129
spx help csr evaluation
125130
```
126131

@@ -163,6 +168,9 @@ curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey" -H "Content-
163168
}' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations"
164169
```
165170

171+
> [!div class="nextstepaction"]
172+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=Speech&Product=Custom-speech&Page=Test-model-quantitatively&Section=Create-a-test" target="_target">I ran into an issue</a>
173+
166174
You should receive a response body in the following format:
167175

168176
```json
@@ -238,6 +246,9 @@ Follow these steps to get test results:
238246

239247
This page lists all the utterances in your dataset and the recognition results, alongside the transcription from the submitted dataset. You can toggle various error types, including insertion, deletion, and substitution. By listening to the audio and comparing recognition results in each column, you can decide which model meets your needs and determine where additional training and improvements are required.
240248

249+
> [!div class="nextstepaction"]
250+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=Speech-studio&Pillar=Speech&Product=Custom-speech&Page=Test-model-quantitatively&Section=Get-test-results" target="_target">I ran into an issue</a>
251+
241252
::: zone-end
242253

243254
::: zone pivot="speech-cli"
@@ -248,10 +259,13 @@ To get test results, use the `spx csr evaluation status` command. Construct the
248259

249260
Here's an example Speech CLI command that gets test results:
250261

251-
```azurecli
262+
```azurecli-interactive
252263
spx csr evaluation status --evaluation 8bfe6b05-f093-4ab4-be7d-180374b751ca
253264
```
254265

266+
> [!div class="nextstepaction"]
267+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CLI&Pillar=Speech&Product=Custom-speech&Page=Test-model-quantitatively&Section=Get-test-results" target="_target">I ran into an issue</a>
268+
255269
The word error rates and more details are returned in the response body.
256270

257271
You should receive a response body in the following format:
@@ -312,7 +326,7 @@ You should receive a response body in the following format:
312326

313327
For Speech CLI help with evaluations, run the following command:
314328

315-
```azurecli
329+
```azurecli-interactive
316330
spx help csr evaluation
317331
```
318332

@@ -328,6 +342,9 @@ Make an HTTP GET request using the URI as shown in the following example. Replac
328342
curl -v -X GET "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/YourEvaluationId" -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey"
329343
```
330344

345+
> [!div class="nextstepaction"]
346+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=Speech&Product=Custom-speech&Page=Test-model-quantitatively&Section=Get-test-results" target="_target">I ran into an issue</a>
347+
331348
The word error rates and more details are returned in the response body.
332349

333350
You should receive a response body in the following format:

articles/cognitive-services/Speech-Service/how-to-custom-speech-inspect-data.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ Follow these instructions to create a test:
3939
1. Enter the test name and description, and then select **Next**.
4040
1. Review your settings, and then select **Save and close**.
4141

42+
> [!div class="nextstepaction"]
43+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=Speech-studio&Pillar=Speech&Product=Custom-speech&Page=Test-recognition-quality&Section=Create-a-test" target="_target">I ran into an issue</a>
44+
4245
::: zone-end
4346

4447
::: zone pivot="speech-cli"
@@ -54,10 +57,13 @@ To create a test, use the `spx csr evaluation create` command. Construct the req
5457

5558
Here's an example Speech CLI command that creates a test:
5659

57-
```azurecli
60+
```azurecli-interactive
5861
spx csr evaluation create --project 9f8c4cbb-f9a5-4ec1-8bb0-53cfa9221226 --dataset be378d9d-a9d7-4d4a-820a-e0432e8678c7 --model1 ff43e922-e3e6-4bf0-8473-55c08fd68048 --model2 1aae1070-7972-47e9-a977-87e3b05c457d --name "My Inspection" --description "My Inspection Description"
5962
```
6063

64+
> [!div class="nextstepaction"]
65+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CLI&Pillar=Speech&Product=Custom-speech&Page=Test-recognition-quality&Section=Create-a-test" target="_target">I ran into an issue</a>
66+
6167
You should receive a response body in the following format:
6268

6369
```json
@@ -115,7 +121,7 @@ The top-level `self` property in the response body is the evaluation's URI. Use
115121

116122
For Speech CLI help with evaluations, run the following command:
117123

118-
```azurecli
124+
```azurecli-interactive
119125
spx help csr evaluation
120126
```
121127

@@ -154,6 +160,9 @@ curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey" -H "Content-
154160
}' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations"
155161
```
156162

163+
> [!div class="nextstepaction"]
164+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=Speech&Product=Custom-speech&Page=Test-recognition-quality&Section=Create-a-test" target="_target">I ran into an issue</a>
165+
157166
You should receive a response body in the following format:
158167

159168
```json
@@ -227,6 +236,9 @@ Follow these steps to get test results:
227236

228237
This page lists all the utterances in your dataset and the recognition results, alongside the transcription from the submitted dataset. You can toggle various error types, including insertion, deletion, and substitution. By listening to the audio and comparing recognition results in each column, you can decide which model meets your needs and determine where additional training and improvements are required.
229238

239+
> [!div class="nextstepaction"]
240+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=Speech-studio&Pillar=Speech&Product=Custom-speech&Page=Test-recognition-quality&Section=Get-test-results" target="_target">I ran into an issue</a>
241+
230242
::: zone-end
231243

232244
::: zone pivot="speech-cli"
@@ -237,10 +249,13 @@ To get test results, use the `spx csr evaluation status` command. Construct the
237249

238250
Here's an example Speech CLI command that gets test results:
239251

240-
```azurecli
252+
```azurecli-interactive
241253
spx csr evaluation status --evaluation 8bfe6b05-f093-4ab4-be7d-180374b751ca
242254
```
243255

256+
> [!div class="nextstepaction"]
257+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=CLI&Pillar=Speech&Product=Custom-speech&Page=Test-recognition-quality&Section=Get-test-results" target="_target">I ran into an issue</a>
258+
244259
The models, audio dataset, transcriptions, and more details are returned in the response body.
245260

246261
You should receive a response body in the following format:
@@ -298,7 +313,7 @@ You should receive a response body in the following format:
298313

299314
For Speech CLI help with evaluations, run the following command:
300315

301-
```azurecli
316+
```azurecli-interactive
302317
spx help csr evaluation
303318
```
304319

@@ -314,6 +329,9 @@ Make an HTTP GET request using the URI as shown in the following example. Replac
314329
curl -v -X GET "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/YourEvaluationId" -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey"
315330
```
316331

332+
> [!div class="nextstepaction"]
333+
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST&Pillar=Speech&Product=Custom-speech&Page=Test-recognition-quality&Section=Get-test-results" target="_target">I ran into an issue</a>
334+
317335
The models, audio dataset, transcriptions, and more details are returned in the response body.
318336

319337
You should receive a response body in the following format:

articles/cognitive-services/Speech-Service/how-to-custom-speech-model-and-endpoint-lifecycle.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ To get the training and transcription expiration dates for a base model, use the
6868

6969
Here's an example Speech CLI command to get the training and transcription expiration dates for a base model:
7070

71-
```azurecli
71+
```azurecli-interactive
7272
spx csr model status --model https://eastus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/b0bbc1e0-78d5-468b-9b7c-a5a43b2bb83f
7373
```
7474

@@ -100,7 +100,7 @@ You should receive a response body in the following format:
100100

101101
For Speech CLI help with models, run the following command:
102102

103-
```azurecli
103+
```azurecli-interactive
104104
spx help csr model
105105
```
106106

@@ -176,7 +176,7 @@ To get the transcription expiration date for your custom model, use the `spx csr
176176

177177
Here's an example Speech CLI command to get the transcription expiration date for your custom model:
178178

179-
```azurecli
179+
```azurecli-interactive
180180
spx csr model status --model https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.0/models/YourModelId
181181
```
182182

@@ -219,7 +219,7 @@ You should receive a response body in the following format:
219219

220220
For Speech CLI help with models, run the following command:
221221

222-
```azurecli
222+
```azurecli-interactive
223223
spx help csr model
224224
```
225225

0 commit comments

Comments
 (0)