You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/speech-service/how-to-custom-speech-deploy-model.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,11 +80,11 @@ Select the endpoint link to view information specific to it, such as the endpoin
80
80
81
81
To create an endpoint and deploy a model, use the `spx csr endpoint create` command. Construct the request parameters according to the following instructions:
82
82
83
-
- Set the `project`parameter to the ID of an existing project. This is recommended so that you can also view and manage the endpoint in Speech Studio. You can run the `spx csr project list` command to get available projects.
84
-
- Set the required `model`parameter to the ID of the model that you want deployed to the endpoint.
85
-
- Set the required `language`parameter. The endpoint locale must match the locale of the model. The locale can't be changed later. The Speech CLI `language`parameter corresponds to the `locale` property in the JSON request and response.
86
-
- 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.
87
-
- Optionally, you can set the `logging`parameter. Set this to `enabled` to enable audio and diagnostic [logging](#view-logging-data) of the endpoint's traffic. The default is `false`.
83
+
- 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). You can run the `spx csr project list` command to get available projects.
84
+
- Set the required `model`property to the ID of the model that you want deployed to the endpoint.
85
+
- 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.
86
+
- Set the required `name`property. This is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com). The Speech CLI `name`property corresponds to the `displayName` property in the JSON request and response.
87
+
- Optionally, you can set the `logging`property. Set this to `enabled` to enable audio and diagnostic [logging](#view-logging-data) of the endpoint's traffic. The default is `false`.
88
88
89
89
Here's an example Speech CLI command to create an endpoint and deploy a model:
90
90
@@ -138,10 +138,10 @@ spx help csr endpoint
138
138
139
139
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:
140
140
141
-
- Set the `project` property to the URI of an existing project. This is recommended so that you can also view and manage the endpoint in Speech Studio. You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
141
+
- 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). You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
142
142
- Set the required `model` property to the URI of the model that you want deployed to the endpoint.
143
143
- Set the required `locale` property. The endpoint locale must match the locale of the model. The locale can't be changed later.
144
-
- Set the required `displayName` property. This is the name that is displayed in the Speech Studio.
144
+
- Set the required `displayName` property. This is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com).
145
145
- Optionally, you can set the `loggingEnabled` property within `properties`. Set this to `true` to enable audio and diagnostic [logging](#view-logging-data) of the endpoint's traffic. The default is `false`.
146
146
147
147
Make an HTTP POST request using the URI as shown in the following [Endpoints_Create](/rest/api/speechtotext/endpoints/create) example. Replace `YourSubscriptionKey` with your Speech resource key, replace `YourServiceRegion` with your Speech resource region, and set the request body properties as previously described.
@@ -225,8 +225,8 @@ To use a new model and redeploy the custom endpoint:
225
225
226
226
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:
227
227
228
-
- Set the required `endpoint`parameter to the ID of the endpoint that you want deployed.
229
-
- Set the required `model`parameter to the ID of the model that you want deployed to the endpoint.
228
+
- Set the required `endpoint`property to the ID of the endpoint that you want deployed.
229
+
- Set the required `model`property to the ID of the model that you want deployed to the endpoint.
230
230
231
231
Here's an example Speech CLI command that redeploys the custom endpoint with a new model:
232
232
@@ -351,7 +351,7 @@ To download the endpoint logs:
351
351
352
352
To get logs for an endpoint, use the `spx csr endpoint list` command. Construct the request parameters according to the following instructions:
353
353
354
-
- Set the required `endpoint`parameter to the ID of the endpoint that you want to get logs.
354
+
- Set the required `endpoint`property to the ID of the endpoint that you want to get logs.
355
355
356
356
Here's an example Speech CLI command that gets logs for an endpoint:
Copy file name to clipboardExpand all lines: articles/ai-services/speech-service/how-to-custom-speech-evaluate-data.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,12 +69,12 @@ Follow these steps to create an accuracy test:
69
69
70
70
To create a test, use the `spx csr evaluation create` command. Construct the request parameters according to the following instructions:
71
71
72
-
- Set the `project`parameter to the ID of an existing project. This parameter is recommended so that you can also view the test in Speech Studio. You can run the `spx csr project list` command to get available projects.
73
-
- Set the required `model1`parameter to the ID of a model that you want to test.
74
-
- Set the required `model2`parameter 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`.
75
-
- Set the required `dataset`parameter to the ID of a dataset that you want to use for the test.
76
-
- Set the `language`parameter, otherwise the Speech CLI sets "en-US" by default. This parameter should be the locale of the dataset contents. The locale can't be changed later. The Speech CLI `language`parameter corresponds to the `locale` property in the JSON request and response.
77
-
- Set the required `name`parameter. This parameter 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.
72
+
- 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). You can run the `spx csr project list` command to get available projects.
73
+
- Set the required `model1`property to the ID of a model that you want to test.
74
+
- 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`.
75
+
- Set the required `dataset`property to the ID of a dataset that you want to use for the test.
76
+
- Set the `language`property, otherwise the Speech CLI sets "en-US" by default. This parameter should be the locale of the dataset contents. The locale can't be changed later. The Speech CLI `language`property corresponds to the `locale` property in the JSON request and response.
77
+
- Set the required `name`property. This parameter is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com). The Speech CLI `name`property corresponds to the `displayName` property in the JSON request and response.
78
78
79
79
Here's an example Speech CLI command that creates a test:
80
80
@@ -152,13 +152,13 @@ spx help csr evaluation
152
152
153
153
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:
154
154
155
-
- Set the `project` property to the URI of an existing project. This property is recommended so that you can also view the test in Speech Studio. You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
156
-
- 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 Speech Studio.
155
+
- 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). You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
156
+
- 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).
157
157
- Set the required `model1` property to the URI of a model that you want to test.
158
158
- 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`.
159
159
- Set the required `dataset` property to the URI of a dataset that you want to use for the test.
160
160
- Set the required `locale` property. This property should be the locale of the dataset contents. The locale can't be changed later.
161
-
- Set the required `displayName` property. This property is the name that is displayed in the Speech Studio.
161
+
- Set the required `displayName` property. This property is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com).
162
162
163
163
Make an HTTP POST request using the URI as shown in the following example. Replace `YourSubscriptionKey` with your Speech resource key, replace `YourServiceRegion` with your Speech resource region, and set the request body properties as previously described.
164
164
@@ -272,7 +272,7 @@ This page lists all the utterances in your dataset and the recognition results,
272
272
273
273
To get test results, use the `spx csr evaluation status` command. Construct the request parameters according to the following instructions:
274
274
275
-
- Set the required `evaluation`parameter to the ID of the evaluation that you want to get test results.
275
+
- Set the required `evaluation`property to the ID of the evaluation that you want to get test results.
276
276
277
277
Here's an example Speech CLI command that gets test results:
278
278
@@ -539,7 +539,7 @@ Incorrectly identified words fall into three categories:
539
539
* Deletion (D): Words that are undetected in the hypothesis transcript
540
540
* Substitution (S): Words that were substituted between reference and hypothesis
541
541
542
-
In the Speech Studio, the quotient is multiplied by 100 and shown as a percentage. The Speech CLI and REST API results aren't multiplied by 100.
542
+
In the [Azure AI Foundry portal](https://ai.azure.com) and [Speech Studio](https://speech.microsoft.com), the quotient is multiplied by 100 and shown as a percentage. The Speech CLI and REST API results aren't multiplied by 100.
# Test recognition quality of a custom speech model
16
16
17
-
You can inspect the recognition quality of a custom speech model in the [Speech Studio](https://aka.ms/speechstudio/customspeech). You can play back uploaded audio and determine if the provided recognition result is correct. After a test is successfully created, you can see how a model transcribed the audio dataset, or compare results from two models side by side.
17
+
You can inspect the recognition quality of a custom speech model. You can play back uploaded audio and determine if the provided recognition result is correct. After a test is successfully created, you can see how a model transcribed the audio dataset, or compare results from two models side by side.
18
18
19
19
Side-by-side model testing is useful to validate which speech recognition model is best for an application. For an objective measure of accuracy, which requires transcription datasets input, see [Test model quantitatively](how-to-custom-speech-evaluate-data.md).
20
20
@@ -24,7 +24,6 @@ Side-by-side model testing is useful to validate which speech recognition model
24
24
25
25
::: zone pivot="ai-foundry-portal"
26
26
27
-
28
27
1. After the model is trained, select **Test models** from the left menu. Then select **+ Create test**.
29
28
30
29
:::image type="content" source="./media/ai-foundry/custom-speech/new-fine-tune-test-model.png" alt-text="Screenshot of the page with an option to test your custom speech model." lightbox="./media/ai-foundry/custom-speech/new-fine-tune-test-model.png":::
@@ -62,12 +61,12 @@ Follow these instructions to create a test:
62
61
63
62
To create a test, use the `spx csr evaluation create` command. Construct the request parameters according to the following instructions:
64
63
65
-
- Set the `project`parameter to the ID of an existing project. This parameter is recommended so that you can also view the test in Speech Studio. You can run the `spx csr project list` command to get available projects.
66
-
- Set the required `model1`parameter to the ID of a model that you want to test.
67
-
- Set the required `model2`parameter 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`.
68
-
- Set the required `dataset`parameter to the ID of a dataset that you want to use for the test.
69
-
- Set the `language`parameter, otherwise the Speech CLI sets "en-US" by default. This parameter should be the locale of the dataset contents. The locale can't be changed later. The Speech CLI `language`parameter corresponds to the `locale` property in the JSON request and response.
70
-
- Set the required `name`parameter. This parameter 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.
64
+
- 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). You can run the `spx csr project list` command to get available projects.
65
+
- Set the required `model1`property to the ID of a model that you want to test.
66
+
- 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`.
67
+
- Set the required `dataset`property to the ID of a dataset that you want to use for the test.
68
+
- Set the `language`property, otherwise the Speech CLI sets "en-US" by default. This parameter should be the locale of the dataset contents. The locale can't be changed later. The Speech CLI `language`property corresponds to the `locale` property in the JSON request and response.
69
+
- Set the required `name`property. This parameter is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com). The Speech CLI `name`property corresponds to the `displayName` property in the JSON request and response.
71
70
72
71
Here's an example Speech CLI command that creates a test:
73
72
@@ -142,12 +141,12 @@ spx help csr evaluation
142
141
143
142
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:
144
143
145
-
- Set the `project` property to the URI of an existing project. This property is recommended so that you can also view the test in Speech Studio. You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
144
+
- 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). You can make a [Projects_List](/rest/api/speechtotext/projects/list) request to get available projects.
146
145
- Set the required `model1` property to the URI of a model that you want to test.
147
146
- 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`.
148
147
- Set the required `dataset` property to the URI of a dataset that you want to use for the test.
149
148
- Set the required `locale` property. This property should be the locale of the dataset contents. The locale can't be changed later.
150
-
- Set the required `displayName` property. This property is the name that is displayed in the Speech Studio.
149
+
- Set the required `displayName` property. This property is the name that is displayed in the [Azure AI Foundry portal](https://ai.azure.com).
151
150
152
151
Make an HTTP POST request using the URI as shown in the following example. Replace `YourSubscriptionKey` with your Speech resource key, replace `YourServiceRegion` with your Speech resource region, and set the request body properties as previously described.
153
152
@@ -256,7 +255,7 @@ This page lists all the utterances in your dataset and the recognition results,
256
255
257
256
To get test results, use the `spx csr evaluation status` command. Construct the request parameters according to the following instructions:
258
257
259
-
- Set the required `evaluation`parameter to the ID of the evaluation that you want to get test results.
258
+
- Set the required `evaluation`property to the ID of the evaluation that you want to get test results.
260
259
261
260
Here's an example Speech CLI command that gets test results:
Copy file name to clipboardExpand all lines: articles/ai-services/speech-service/how-to-custom-speech-model-and-endpoint-lifecycle.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ Follow these instructions to get the transcription expiration date for a base mo
73
73
74
74
To get the training and transcription expiration dates for a base model, use the `spx csr model status` command. Construct the request parameters according to the following instructions:
75
75
76
-
- Set the `url`parameter to the URI of the base model that you want to get. You can run the `spx csr list --base` command to get available base models for all locales.
76
+
- Set the `url`property to the URI of the base model that you want to get. You can run the `spx csr list --base` command to get available base models for all locales.
77
77
78
78
Here's an example Speech CLI command to get the training and transcription expiration dates for a base model:
79
79
@@ -159,7 +159,6 @@ You should receive a response body in the following format:
159
159
::: zone pivot="ai-foundry-portal"
160
160
161
161
162
-
163
162
::: zone-end
164
163
165
164
::: zone pivot="speech-studio"
@@ -187,7 +186,7 @@ You can also follow these instructions to get the transcription expiration date
187
186
188
187
To get the transcription expiration date for your custom model, use the `spx csr model status` command. Construct the request parameters according to the following instructions:
189
188
190
-
- Set the `url`parameter to the URI of the model that you want to get. Replace `YourModelId` with your model ID and replace `YourServiceRegion` with your Speech resource region.
189
+
- Set the `url`property to the URI of the model that you want to get. Replace `YourModelId` with your model ID and replace `YourServiceRegion` with your Speech resource region.
191
190
192
191
Here's an example Speech CLI command to get the transcription expiration date for your custom model:
0 commit comments