forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add 2024-05-15-preview of SpeechToText API (CognitiveServices) (Azure…
…#29804) * Add preview GA as base * Updates for new preview version * Update readme.md * Added required ttl to examples * Add description * Add missing example * Keep latest GA latest
- Loading branch information
1 parent
37ea157
commit 03989d9
Showing
93 changed files
with
11,417 additions
and
1 deletion.
There are no files selected for viewing
27 changes: 27 additions & 0 deletions
27
...data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", | ||
| "blockList": [ | ||
| { | ||
| "kind": "Uncommitted", | ||
| "id": "AAA=" | ||
| }, | ||
| { | ||
| "kind": "Uncommitted", | ||
| "id": "AAE=" | ||
| }, | ||
| { | ||
| "kind": "Uncommitted", | ||
| "id": "AAI=" | ||
| } | ||
| ] | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "headers": {} | ||
| } | ||
| } | ||
| } |
31 changes: 31 additions & 0 deletions
31
...peech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "id": "827712a5-f942-4997-91c3-7c6cde35600b", | ||
| "modelCopyAuthorization": { | ||
| "targetResourceRegion": "westus2", | ||
| "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", | ||
| "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/models?api-version=2024-05-15-preview", | ||
| "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", | ||
| "expirationDateTime": "2019-01-07T11:34:12Z", | ||
| "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" | ||
| }, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview" | ||
| }, | ||
| "body": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview", | ||
| "createdDateTime": "2019-01-07T11:34:12Z", | ||
| "lastActionDateTime": "2019-01-07T11:34:12Z", | ||
| "status": "NotStarted", | ||
| "id": "e30f6a27-82be-4cca-9258-0399c70489ff" | ||
| } | ||
| } | ||
| } | ||
| } |
58 changes: 58 additions & 0 deletions
58
...eech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "transcription": { | ||
| "contentContainerUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/audiofiles/", | ||
| "properties": { | ||
| "diarizationEnabled": false, | ||
| "wordLevelTimestampsEnabled": false, | ||
| "displayFormWordLevelTimestampsEnabled": false, | ||
| "punctuationMode": "DictatedAndAutomatic", | ||
| "profanityFilterMode": "Masked", | ||
| "timeToLive": "P2D" | ||
| }, | ||
| "locale": "en-US", | ||
| "displayName": "Transcription of storage container using default model for en-US" | ||
| }, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "headers": { | ||
| "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" | ||
| }, | ||
| "body": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", | ||
| "model": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" | ||
| }, | ||
| "links": { | ||
| "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" | ||
| }, | ||
| "properties": { | ||
| "diarizationEnabled": false, | ||
| "wordLevelTimestampsEnabled": false, | ||
| "displayFormWordLevelTimestampsEnabled": false, | ||
| "channels": [ | ||
| 0, | ||
| 1 | ||
| ], | ||
| "punctuationMode": "DictatedAndAutomatic", | ||
| "profanityFilterMode": "Masked", | ||
| "duration": "PT42S", | ||
| "timeToLive": "P2D" | ||
| }, | ||
| "lastActionDateTime": "2019-01-07T11:36:07Z", | ||
| "status": "Succeeded", | ||
| "createdDateTime": "2019-01-07T11:34:12Z", | ||
| "locale": "en-US", | ||
| "displayName": "Transcription using adapted model en-US", | ||
| "customProperties": { | ||
| "key": "value" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
...ech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "modelCopyAuthorizationDefinition": { | ||
| "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName" | ||
| }, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "headers": {}, | ||
| "body": { | ||
| "targetResourceRegion": "westus2", | ||
| "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", | ||
| "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/models?api-version=2024-05-15-preview", | ||
| "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", | ||
| "expirationDateTime": "2019-01-07T11:34:12Z", | ||
| "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" | ||
| } | ||
| } | ||
| } | ||
| } |
34 changes: 34 additions & 0 deletions
34
...e/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "dataset": { | ||
| "kind": "Acoustic", | ||
| "locale": "en-US", | ||
| "displayName": "My speech dataset name", | ||
| "description": "My speech dataset description" | ||
| }, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "headers": {}, | ||
| "body": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", | ||
| "kind": "Acoustic", | ||
| "links": { | ||
| "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/files?api-version=2024-05-15-preview", | ||
| "commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks:commit?api-version=2024-05-15-preview", | ||
| "listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks?api-version=2024-05-15-preview", | ||
| "uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks?api-version=2024-05-15-preview" | ||
| }, | ||
| "lastActionDateTime": "2019-01-07T11:36:07Z", | ||
| "status": "NotStarted", | ||
| "createdDateTime": "2019-01-07T11:34:12Z", | ||
| "locale": "en-US", | ||
| "displayName": "Acoustic dataset" | ||
| } | ||
| } | ||
| } | ||
| } |
41 changes: 41 additions & 0 deletions
41
...ech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "dataset": { | ||
| "kind": "Acoustic", | ||
| "contentUrl": "https://contoso.com/location", | ||
| "locale": "en-US", | ||
| "displayName": "My speech dataset name", | ||
| "description": "My speech dataset description" | ||
| }, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "headers": { | ||
| "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" | ||
| }, | ||
| "body": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", | ||
| "kind": "Acoustic", | ||
| "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", | ||
| "links": { | ||
| "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" | ||
| }, | ||
| "properties": { | ||
| "textNormalizationKind": "Default", | ||
| "acceptedLineCount": 11, | ||
| "rejectedLineCount": 2, | ||
| "duration": "PT4M12S" | ||
| }, | ||
| "lastActionDateTime": "2019-01-07T11:36:07Z", | ||
| "status": "Succeeded", | ||
| "createdDateTime": "2019-01-07T11:34:12Z", | ||
| "locale": "en-US", | ||
| "displayName": "Acoustic dataset" | ||
| } | ||
| } | ||
| } | ||
| } |
51 changes: 51 additions & 0 deletions
51
...s/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "endpoint": { | ||
| "model": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" | ||
| }, | ||
| "properties": { | ||
| "loggingEnabled": true | ||
| }, | ||
| "locale": "en-US", | ||
| "displayName": "Speech endpoint definition", | ||
| "description": "This is a speech endpoint" | ||
| }, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "headers": { | ||
| "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview" | ||
| }, | ||
| "body": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", | ||
| "model": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" | ||
| }, | ||
| "links": { | ||
| "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", | ||
| "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", | ||
| "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", | ||
| "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", | ||
| "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", | ||
| "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", | ||
| "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" | ||
| }, | ||
| "properties": { | ||
| "timeToLive": "PT30M", | ||
| "loggingEnabled": true | ||
| }, | ||
| "lastActionDateTime": "2019-01-07T11:36:07Z", | ||
| "status": "Succeeded", | ||
| "createdDateTime": "2019-01-07T11:34:12Z", | ||
| "locale": "en-US", | ||
| "displayName": "Speech endpoint", | ||
| "description": "Example for speech endpoint" | ||
| } | ||
| } | ||
| } | ||
| } |
117 changes: 117 additions & 0 deletions
117
...data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| { | ||
| "parameters": { | ||
| "Endpoint": "https://westus.api.cognitive.microsoft.com/", | ||
| "Ocp-Apim-Subscription-Key": "{API Key}", | ||
| "api-version": "2024-05-15-preview", | ||
| "evaluation": { | ||
| "model1": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" | ||
| }, | ||
| "model2": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" | ||
| }, | ||
| "dataset": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" | ||
| }, | ||
| "locale": "en-US", | ||
| "displayName": "My new evaluation", | ||
| "description": "The description of the evaluation" | ||
| }, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "headers": { | ||
| "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview" | ||
| }, | ||
| "body": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview", | ||
| "model1": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" | ||
| }, | ||
| "model2": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" | ||
| }, | ||
| "dataset": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" | ||
| }, | ||
| "transcription2": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" | ||
| }, | ||
| "transcription1": { | ||
| "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" | ||
| }, | ||
| "links": { | ||
| "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" | ||
| }, | ||
| "properties": { | ||
| "wordErrorRate1": 0.065, | ||
| "sentenceErrorRate1": 0.375, | ||
| "tokenErrorRate1": 0.125, | ||
| "sentenceCount1": 8, | ||
| "wordCount1": 46, | ||
| "correctWordCount1": 43, | ||
| "wordSubstitutionCount1": 3, | ||
| "wordDeletionCount1": 0, | ||
| "wordInsertionCount1": 0, | ||
| "tokenCount1": 48, | ||
| "correctTokenCount1": 42, | ||
| "tokenSubstitutionCount1": 6, | ||
| "tokenDeletionCount1": 0, | ||
| "tokenInsertionCount1": 0, | ||
| "tokenErrors1": { | ||
| "punctuation": { | ||
| "numberOfEdits": 2, | ||
| "percentageOfAllEdits": 0.66 | ||
| }, | ||
| "capitalization": { | ||
| "numberOfEdits": 1, | ||
| "percentageOfAllEdits": 0.33 | ||
| } | ||
| }, | ||
| "wordErrorRate2": 0.065, | ||
| "sentenceErrorRate2": 0.375, | ||
| "tokenErrorRate2": 0.125, | ||
| "sentenceCount2": 8, | ||
| "wordCount2": 46, | ||
| "correctWordCount2": 43, | ||
| "wordSubstitutionCount2": 3, | ||
| "wordDeletionCount2": 0, | ||
| "wordInsertionCount2": 0, | ||
| "tokenCount2": 48, | ||
| "correctTokenCount2": 42, | ||
| "tokenSubstitutionCount2": 6, | ||
| "tokenDeletionCount2": 0, | ||
| "tokenInsertionCount2": 0, | ||
| "tokenErrors2": { | ||
| "punctuation": { | ||
| "numberOfEdits": 208, | ||
| "percentageOfAllEdits": 1.22 | ||
| }, | ||
| "capitalization": { | ||
| "numberOfEdits": 126, | ||
| "percentageOfAllEdits": 0.74 | ||
| }, | ||
| "inverseTextNormalization": { | ||
| "numberOfEdits": 409, | ||
| "percentageOfAllEdits": 2.4 | ||
| }, | ||
| "lexical": { | ||
| "numberOfEdits": 16284, | ||
| "percentageOfAllEdits": 95.41 | ||
| }, | ||
| "others": { | ||
| "numberOfEdits": 41, | ||
| "percentageOfAllEdits": 0.24 | ||
| } | ||
| } | ||
| }, | ||
| "lastActionDateTime": "2019-01-07T11:36:07Z", | ||
| "status": "Succeeded", | ||
| "createdDateTime": "2019-01-07T11:34:12Z", | ||
| "locale": "en-US", | ||
| "displayName": "Evalution of one model against another model" | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.