Skip to content

Commit a557a54

Browse files
lbussardlbussard
authored
Create OpenAPI specs for speech service API v3.2-preview2 (#26285)
* Clone of 3.2-preview1 as 3.2-preview2 * Run prettier and update readme * Add new copy model. This is the only change betweeen 3.2 preview1 and 3.2 preview 2 * rename 3.2-preview2 to 3.2-preview.2 * Re-trigger checking tools (authorizecopy is in custom-words.txt)
1 parent 0ead93d commit a557a54

File tree

96 files changed

+10975
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+10975
-0
lines changed

‎custom-words.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,7 @@ authenticationsettings
228228
authenticode
229229
authkey
230230
authorizationrules
231+
authorizecopy
231232
authpriv
232233
authprovider
233234
authproviders

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/commit_block_list.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
6+
"blockList": [
7+
{
8+
"kind": "Uncommitted",
9+
"id": "AAA="
10+
},
11+
{
12+
"kind": "Uncommitted",
13+
"id": "AAE="
14+
},
15+
{
16+
"kind": "Uncommitted",
17+
"id": "AAI="
18+
}
19+
]
20+
},
21+
"responses": {
22+
"200": {
23+
"headers": {}
24+
}
25+
}
26+
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/copy_model.json‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"id": "827712a5-f942-4997-91c3-7c6cde35600b",
6+
"modelCopy": {
7+
"targetSubscriptionKey": "KeyForTheSubscriptionTheModelIsSupposedToBeCopiedTo"
8+
},
9+
"Content-Type": "application/json"
10+
},
11+
"responses": {
12+
"201": {
13+
"headers": {},
14+
"body": {
15+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
16+
"baseModel": {
17+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
18+
},
19+
"datasets": [
20+
{
21+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
22+
}
23+
],
24+
"links": {
25+
"manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
26+
"copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
27+
"copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
28+
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
29+
},
30+
"properties": {
31+
"deprecationDates": {
32+
"transcriptionDateTime": "2023-05-04T00:00:00Z"
33+
},
34+
"customModelWeightPercent": 30,
35+
"features": {
36+
"supportsTranscriptions": true,
37+
"supportsEndpoints": true,
38+
"supportsTranscriptionsOnSpeechContainers": false,
39+
"supportedOutputFormats": [
40+
"Lexical",
41+
"Display"
42+
]
43+
}
44+
},
45+
"lastActionDateTime": "2019-01-07T11:36:07Z",
46+
"status": "Running",
47+
"createdDateTime": "2019-01-07T11:34:12Z",
48+
"locale": "en-US",
49+
"displayName": "Language model",
50+
"description": "This is a language model"
51+
}
52+
}
53+
}
54+
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/copy_model_with_authorization.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"id": "827712a5-f942-4997-91c3-7c6cde35600b",
6+
"modelCopyAuthorization": {
7+
"targetResourceRegion": "westus2",
8+
"targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName",
9+
"targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models",
10+
"sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName",
11+
"expirationDateTime": "2019-01-07T11:34:12Z",
12+
"id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b"
13+
},
14+
"Content-Type": "application/json"
15+
},
16+
"responses": {
17+
"202": {
18+
"headers": {
19+
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF"
20+
},
21+
"body": {
22+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF",
23+
"createdDateTime": "2019-01-07T11:34:12Z",
24+
"lastActionDateTime": "2019-01-07T11:34:12Z",
25+
"status": "NotStarted",
26+
"id": "e30f6a27-82be-4cca-9258-0399c70489ff"
27+
}
28+
}
29+
}
30+
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/create_container_transcription.json‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"transcription": {
6+
"contentContainerUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/audiofiles/",
7+
"properties": {
8+
"diarizationEnabled": false,
9+
"wordLevelTimestampsEnabled": false,
10+
"punctuationMode": "DictatedAndAutomatic",
11+
"profanityFilterMode": "Masked"
12+
},
13+
"locale": "en-US",
14+
"displayName": "Transcription of storage container using default model for en-US"
15+
},
16+
"Content-Type": "application/json"
17+
},
18+
"responses": {
19+
"201": {
20+
"headers": {
21+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
22+
},
23+
"body": {
24+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
25+
"model": {
26+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
27+
},
28+
"links": {
29+
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
30+
},
31+
"properties": {
32+
"diarizationEnabled": false,
33+
"wordLevelTimestampsEnabled": false,
34+
"displayFormWordLevelTimestampsEnabled": false,
35+
"channels": [
36+
0,
37+
1
38+
],
39+
"punctuationMode": "DictatedAndAutomatic",
40+
"profanityFilterMode": "Masked",
41+
"duration": "PT42S"
42+
},
43+
"lastActionDateTime": "2019-01-07T11:36:07Z",
44+
"status": "Succeeded",
45+
"createdDateTime": "2019-01-07T11:34:12Z",
46+
"locale": "en-US",
47+
"displayName": "Transcription using adapted model en-US",
48+
"customProperties": {
49+
"key": "value"
50+
}
51+
}
52+
}
53+
}
54+
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/create_copy_model_authorization.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"modelCopyAuthorizationDefinition": {
6+
"sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName"
7+
},
8+
"Content-Type": "application/json"
9+
},
10+
"responses": {
11+
"200": {
12+
"headers": {},
13+
"body": {
14+
"targetResourceRegion": "westus2",
15+
"targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName",
16+
"targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models",
17+
"sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName",
18+
"expirationDateTime": "2019-01-07T11:34:12Z",
19+
"id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b"
20+
}
21+
}
22+
}
23+
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/create_dataset_with_blocks.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"dataset": {
6+
"kind": "Acoustic",
7+
"locale": "en-US",
8+
"displayName": "My speech dataset name",
9+
"description": "My speech dataset description"
10+
},
11+
"Content-Type": "application/json"
12+
},
13+
"responses": {
14+
"201": {
15+
"headers": {},
16+
"body": {
17+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
18+
"kind": "Acoustic",
19+
"links": {
20+
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files",
21+
"commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks:commit",
22+
"listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks",
23+
"uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks"
24+
},
25+
"lastActionDateTime": "2019-01-07T11:36:07Z",
26+
"status": "NotStarted",
27+
"createdDateTime": "2019-01-07T11:34:12Z",
28+
"locale": "en-US",
29+
"displayName": "Acoustic dataset"
30+
}
31+
}
32+
}
33+
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/create_dataset_with_content_url.json‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"dataset": {
6+
"kind": "Acoustic",
7+
"contentUrl": "https://contoso.com/location",
8+
"locale": "en-US",
9+
"displayName": "My speech dataset name",
10+
"description": "My speech dataset description"
11+
},
12+
"Content-Type": "application/json"
13+
},
14+
"responses": {
15+
"201": {
16+
"headers": {
17+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
18+
},
19+
"body": {
20+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
21+
"kind": "Acoustic",
22+
"contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
23+
"links": {
24+
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
25+
},
26+
"properties": {
27+
"textNormalizationKind": "Default",
28+
"acceptedLineCount": 11,
29+
"rejectedLineCount": 2,
30+
"duration": "PT4M12S"
31+
},
32+
"lastActionDateTime": "2019-01-07T11:36:07Z",
33+
"status": "Succeeded",
34+
"createdDateTime": "2019-01-07T11:34:12Z",
35+
"locale": "en-US",
36+
"displayName": "Acoustic dataset"
37+
}
38+
}
39+
}
40+
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/v3.2-preview.2/examples/create_endpoint.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "https://westus.api.cognitive.microsoft.com/",
4+
"Ocp-Apim-Subscription-Key": "{API Key}",
5+
"endpoint": {
6+
"model": {
7+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
8+
},
9+
"properties": {
10+
"loggingEnabled": true
11+
},
12+
"locale": "en-US",
13+
"displayName": "Speech endpoint definition",
14+
"description": "This is a speech endpoint"
15+
},
16+
"Content-Type": "application/json"
17+
},
18+
"responses": {
19+
"201": {
20+
"headers": {
21+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6"
22+
},
23+
"body": {
24+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
25+
"model": {
26+
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
27+
},
28+
"links": {
29+
"logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
30+
"restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
31+
"restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
32+
"restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
33+
"webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
34+
"webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
35+
"webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
36+
},
37+
"properties": {
38+
"timeToLive": "PT30M",
39+
"loggingEnabled": true
40+
},
41+
"lastActionDateTime": "2019-01-07T11:36:07Z",
42+
"status": "Succeeded",
43+
"createdDateTime": "2019-01-07T11:34:12Z",
44+
"locale": "en-US",
45+
"displayName": "Speech endpoint",
46+
"description": "Example for speech endpoint"
47+
}
48+
}
49+
}
50+
}

0 commit comments

Comments
 (0)