@@ -6,7 +6,7 @@ author: eric-urban
6
6
manager : nitinme
7
7
ms.service : azure-ai-speech
8
8
ms.topic : how-to
9
- ms.date : 4 /15/2024
9
+ ms.date : 7 /15/2024
10
10
ms.author : eur
11
11
zone_pivot_groups : speech-studio-cli-rest
12
12
---
@@ -68,19 +68,19 @@ To create an endpoint and deploy a model, use the `spx csr endpoint create` comm
68
68
Here's an example Speech CLI command to create an endpoint and deploy a model:
69
69
70
70
``` azurecli-interactive
71
- spx csr endpoint create --api-version v3.1 --project YourProjectId --model YourModelId --name "My Endpoint" --description "My Endpoint Description" --language "en-US"
71
+ spx csr endpoint create --api-version v3.2 --project YourProjectId --model YourModelId --name "My Endpoint" --description "My Endpoint Description" --language "en-US"
72
72
```
73
73
74
74
You should receive a response body in the following format:
75
75
76
76
``` json
77
77
{
78
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
78
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
79
79
"model" : {
80
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /models/base/ae8d1643-53e4-4554-be4c-221dcfb471c5"
80
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /models/base/ae8d1643-53e4-4554-be4c-221dcfb471c5"
81
81
},
82
82
"links" : {
83
- "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
83
+ "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
84
84
"restInteractive" : " https://eastus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
85
85
"restConversation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
86
86
"restDictation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
@@ -89,7 +89,7 @@ You should receive a response body in the following format:
89
89
"webSocketDictation" : " wss://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790"
90
90
},
91
91
"project" : {
92
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /projects/d40f2eb8-1abf-4f72-9008-a5ae8add82a4"
92
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /projects/d40f2eb8-1abf-4f72-9008-a5ae8add82a4"
93
93
},
94
94
"properties" : {
95
95
"loggingEnabled" : true
@@ -128,30 +128,30 @@ Make an HTTP POST request using the URI as shown in the following [Endpoints_Cre
128
128
``` azurecli-interactive
129
129
curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey" -H "Content-Type: application/json" -d '{
130
130
"project": {
131
- "self": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /projects/d40f2eb8-1abf-4f72-9008-a5ae8add82a4"
131
+ "self": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /projects/d40f2eb8-1abf-4f72-9008-a5ae8add82a4"
132
132
},
133
133
"properties": {
134
134
"loggingEnabled": true
135
135
},
136
136
"displayName": "My Endpoint",
137
137
"description": "My Endpoint Description",
138
138
"model": {
139
- "self": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /models/base/ae8d1643-53e4-4554-be4c-221dcfb471c5"
139
+ "self": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /models/base/ae8d1643-53e4-4554-be4c-221dcfb471c5"
140
140
},
141
141
"locale": "en-US",
142
- }' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints"
142
+ }' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints"
143
143
```
144
144
145
145
You should receive a response body in the following format:
146
146
147
147
``` json
148
148
{
149
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
149
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
150
150
"model" : {
151
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /models/base/ae8d1643-53e4-4554-be4c-221dcfb471c5"
151
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /models/base/ae8d1643-53e4-4554-be4c-221dcfb471c5"
152
152
},
153
153
"links" : {
154
- "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
154
+ "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
155
155
"restInteractive" : " https://eastus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
156
156
"restConversation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
157
157
"restDictation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
@@ -160,7 +160,7 @@ You should receive a response body in the following format:
160
160
"webSocketDictation" : " wss://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790"
161
161
},
162
162
"project" : {
163
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /projects/d40f2eb8-1abf-4f72-9008-a5ae8add82a4"
163
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /projects/d40f2eb8-1abf-4f72-9008-a5ae8add82a4"
164
164
},
165
165
"properties" : {
166
166
"loggingEnabled" : true
@@ -204,19 +204,19 @@ To redeploy the custom endpoint with a new model, use the `spx csr model update`
204
204
Here's an example Speech CLI command that redeploys the custom endpoint with a new model:
205
205
206
206
``` azurecli-interactive
207
- spx csr endpoint update --api-version v3.1 --endpoint YourEndpointId --model YourModelId
207
+ spx csr endpoint update --api-version v3.2 --endpoint YourEndpointId --model YourModelId
208
208
```
209
209
210
210
You should receive a response body in the following format:
211
211
212
212
``` json
213
213
{
214
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
214
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
215
215
"model" : {
216
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
216
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
217
217
},
218
218
"links" : {
219
- "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
219
+ "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
220
220
"restInteractive" : " https://eastus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
221
221
"restConversation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
222
222
"restDictation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
@@ -225,7 +225,7 @@ You should receive a response body in the following format:
225
225
"webSocketDictation" : " wss://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790"
226
226
},
227
227
"project" : {
228
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /projects/639d5280-8995-40cc-9329-051fd0fddd46"
228
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /projects/639d5280-8995-40cc-9329-051fd0fddd46"
229
229
},
230
230
"properties" : {
231
231
"loggingEnabled" : true
@@ -258,21 +258,21 @@ Make an HTTP PATCH request using the URI as shown in the following example. Repl
258
258
``` azurecli-interactive
259
259
curl -v -X PATCH -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey" -H "Content-Type: application/json" -d '{
260
260
"model": {
261
- "self": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
261
+ "self": "https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
262
262
}
263
- }' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/YourEndpointId"
263
+ }' "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/YourEndpointId"
264
264
```
265
265
266
266
You should receive a response body in the following format:
267
267
268
268
``` json
269
269
{
270
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
270
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
271
271
"model" : {
272
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
272
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
273
273
},
274
274
"links" : {
275
- "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
275
+ "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
276
276
"restInteractive" : " https://eastus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
277
277
"restConversation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
278
278
"restDictation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
@@ -281,7 +281,7 @@ You should receive a response body in the following format:
281
281
"webSocketDictation" : " wss://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790"
282
282
},
283
283
"project" : {
284
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /projects/639d5280-8995-40cc-9329-051fd0fddd46"
284
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /projects/639d5280-8995-40cc-9329-051fd0fddd46"
285
285
},
286
286
"properties" : {
287
287
"loggingEnabled" : true
@@ -323,7 +323,7 @@ To get logs for an endpoint, use the `spx csr endpoint list` command. Construct
323
323
Here's an example Speech CLI command that gets logs for an endpoint:
324
324
325
325
``` azurecli-interactive
326
- spx csr endpoint list --api-version v3.1 --endpoint YourEndpointId
326
+ spx csr endpoint list --api-version v3.2 --endpoint YourEndpointId
327
327
```
328
328
329
329
The locations of each log file with more details are returned in the response body.
@@ -337,19 +337,19 @@ To get logs for an endpoint, start by using the [Endpoints_Get](/rest/api/speech
337
337
Make an HTTP GET request using the URI as shown in the following example. Replace ` YourEndpointId ` with your endpoint ID, replace ` YourSubscriptionKey ` with your Speech resource key, and replace ` YourServiceRegion ` with your Speech resource region.
338
338
339
339
``` azurecli-interactive
340
- curl -v -X GET "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/YourEndpointId" -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey"
340
+ curl -v -X GET "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/YourEndpointId" -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey"
341
341
```
342
342
343
343
You should receive a response body in the following format:
344
344
345
345
``` json
346
346
{
347
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
347
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790" ,
348
348
"model" : {
349
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
349
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /models/1e47c19d-12ca-4ba5-b177-9e04bd72cf98"
350
350
},
351
351
"links" : {
352
- "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
352
+ "logs" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/98375aaa-40c2-42c4-b65c-f76734fc7790/files/logs" ,
353
353
"restInteractive" : " https://eastus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
354
354
"restConversation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
355
355
"restDictation" : " https://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790" ,
@@ -358,7 +358,7 @@ You should receive a response body in the following format:
358
358
"webSocketDictation" : " wss://eastus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=98375aaa-40c2-42c4-b65c-f76734fc7790"
359
359
},
360
360
"project" : {
361
- "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.1 /projects/2f78cdb7-58ac-4bd9-9bc6-170e31483b26"
361
+ "self" : " https://eastus.api.cognitive.microsoft.com/speechtotext/v3.2 /projects/2f78cdb7-58ac-4bd9-9bc6-170e31483b26"
362
362
},
363
363
"properties" : {
364
364
"loggingEnabled" : true
@@ -376,7 +376,7 @@ Make an HTTP GET request using the "logs" URI from the previous response body. R
376
376
377
377
378
378
``` curl
379
- curl -v -X GET "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.1 /endpoints/YourEndpointId/files/logs" -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey"
379
+ curl -v -X GET "https://YourServiceRegion.api.cognitive.microsoft.com/speechtotext/v3.2 /endpoints/YourEndpointId/files/logs" -H "Ocp-Apim-Subscription-Key: YourSubscriptionKey"
380
380
```
381
381
382
382
The locations of each log file with more details are returned in the response body.
0 commit comments