diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index ece6eec1c090..880ec988957b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -4,17 +4,17 @@ Configuration for generating SpeechToText SDK. -The current release for the SpeechToText is `release_3_1`. +The current release for the SpeechToText is `release_3_2`. ``` yaml -tag: release_3_1 +tag: release_3_2 add-credentials: true openapi-type: data-plane ``` # Releases -## SpeechToText 2.0 +## Tag: release_2_0 These settings apply only when `--tag=release_2_0` is specified on the command line. ``` yaml $(tag) == 'release_2_0' @@ -34,7 +34,7 @@ directive: --- -## SpeechToText 3.0 +## Tag: release_3_0 These settings apply only when `--tag=release_3_0` is specified on the command line. ``` yaml $(tag) == 'release_3_0' @@ -52,7 +52,7 @@ directive: --- -## SpeechToText 3.1-preview.1 +## Tag: release_3_1_preview_1 These settings apply only when `--tag=release_3_1_preview_1` is specified on the command line. ``` yaml $(tag) == 'release_3_1_preview_1' @@ -70,7 +70,7 @@ directive: --- -## SpeechToText 3.1 +## Tag: release_3_1 These settings apply only when `--tag=release_3_1` is specified on the command line. @@ -95,7 +95,7 @@ directive: --- -## SpeechToText 3.2-preview.1 +## Tag: release_3_2_preview_1 These settings apply only when `--tag=release_3_2_preview_1` is specified on the command line. @@ -118,7 +118,7 @@ directive: reason: Existing API, change would potentially be breaking. ``` -## SpeechToText 3.2-preview.2 +## Tag: release_3_2_preview_2 These settings apply only when `--tag=release_3_2_preview_2` is specified on the command line. @@ -129,6 +129,29 @@ input-file: AutoRest-Linter Suppressions +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: LongRunningOperationsWithLongRunningExtension + reason: Does not apply in those two places. The method is a DELETE which lazily deletes blobs, so it's Accepted, not NoContent. + - suppress: OperationIdNounVerb + where: $..paths[($..operationId["Models_*"])] + reason: There is a sub-route called /models/base/ that refers to the base models. Therefore, the correct operation ID seems to be "Models_GetBaseModel", for example. + - suppress: HostParametersValidation + reason: Existing API, change would potentially be breaking. +``` + +## Tag: release_3_2 + +These settings apply only when `--tag=release_3_2` is specified on the command line. + +```yaml $(tag) == 'release_3_2' +input-file: + - stable/v3.2/speechtotext.json +``` + +AutoRest-Linter Suppressions + ``` yaml # Ignore autorest-linter issues that cannot be resolve without updates to the API implementation directive: diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/commit_block_list.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/commit_block_list.json new file mode 100644 index 000000000000..6d3b1eeda575 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/commit_block_list.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockList": [ + { + "kind": "Uncommitted", + "id": "AAA=" + }, + { + "kind": "Uncommitted", + "id": "AAE=" + }, + { + "kind": "Uncommitted", + "id": "AAI=" + } + ] + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/copy_model_with_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/copy_model_with_authorization.json new file mode 100644 index 000000000000..3086102ed0c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/copy_model_with_authorization.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "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/v3.2/models", + "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/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_container_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_container_transcription.json new file mode 100644 index 000000000000..ac5ea7d80921 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_container_transcription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentContainerUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/audiofiles/", + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked" + }, + "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/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "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" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_copy_model_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_copy_model_authorization.json new file mode 100644 index 000000000000..dc2b86b0535f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_copy_model_authorization.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "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/v3.2/models", + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", + "expirationDateTime": "2019-01-07T11:34:12Z", + "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_blocks.json new file mode 100644 index 000000000000..ca1564026c0d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_blocks.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "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/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files", + "commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks:commit", + "listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks", + "uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_content_url.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_content_url.json new file mode 100644 index 000000000000..2993368b97be --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_content_url.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "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/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_endpoint.json new file mode 100644 index 000000000000..5c81757ceb7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_endpoint.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpoint": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "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/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_evaluation.json new file mode 100644 index 000000000000..631b0872b7eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_evaluation.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "evaluation": { + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "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/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "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": "Evaluation of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_lid_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_lid_transcription.json new file mode 100644 index 000000000000..911ece0b2afb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_lid_transcription.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + } + } + } + }, + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + } + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale.", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model.json new file mode 100644 index 000000000000..2b6fbde5e7d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model_with_weight.json new file mode 100644 index 000000000000..e98abd9cc543 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model_with_weight.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "properties": { + "customModelWeightPercent": 42 + }, + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_multispeaker_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_multispeaker_diarization_transcription.json new file mode 100644 index 000000000000..aceb1010f7d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_multispeaker_diarization_transcription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_project.json new file mode 100644 index 000000000000..4f01480f899a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_project.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "project": { + "locale": "en-US", + "displayName": "My speech project" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_simple_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_simple_diarization_transcription.json new file mode 100644 index 000000000000..110033c9ab40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_simple_diarization_transcription.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked" + }, + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_uri_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_uri_transcription.json new file mode 100644 index 000000000000..cec1ff91787e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_uri_transcription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation", + "https://contoso.com/myotherstoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked" + }, + "locale": "en-US", + "displayName": "Transcription using default model for en-US" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "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" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_web_hook.json new file mode 100644 index 000000000000..ac660aa02e17 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_web_hook.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "webHook": { + "displayName": "TranscriptionCompletionWebHook", + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "NotStarted" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_log.json new file mode 100644 index 000000000000..44bff0317a1a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_log.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_logs.json new file mode 100644 index 000000000000..5f60e6048e14 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_logs.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_dataset.json new file mode 100644 index 000000000000..6c29b587a750 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_dataset.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint.json new file mode 100644 index 000000000000..d2c284860113 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_log.json new file mode 100644 index 000000000000..eff0e76962b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_log.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_logs.json new file mode 100644 index 000000000000..5bb1d4bd4e2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_logs.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_evaluation.json new file mode 100644 index 000000000000..22349ee5cc12 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_evaluation.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_model.json new file mode 100644 index 000000000000..621d39d9c341 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_model.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_project.json new file mode 100644 index 000000000000..1e73e0f3bc0b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_project.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_transcription.json new file mode 100644 index 000000000000..ec68edb84756 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_transcription.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_web_hook.json new file mode 100644 index 000000000000..23a047a55361 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_web_hook.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_acoustic_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_acoustic_datasets.json new file mode 100644 index 000000000000..f719c51cb90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_acoustic_datasets.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'Acoustic'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "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" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model.json new file mode 100644 index 000000000000..832dad6227c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_log.json new file mode 100644 index 000000000000..d2dd6080f619 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_log.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_logs.json new file mode 100644 index 000000000000..eea139cdf45c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_logs.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/base/en-us/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_manifest.json new file mode 100644 index 000000000000..8b0a567f99d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_manifest.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/02231df2-012f-45d4-9af0-8a3e4ccc877c" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset.json new file mode 100644 index 000000000000..5dba326a0fa8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_blocks.json new file mode 100644 index 000000000000..05066a8753c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_blocks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "uncommittedBlocks": [ + { + "name": "AAA=", + "size": 123 + }, + { + "name": "AAE=", + "size": 234 + }, + { + "name": "AAI=", + "size": 345 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_file.json new file mode 100644 index 000000000000..735e89d754cd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_files.json new file mode 100644 index 000000000000..b0e0e9353538 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_files.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86", + "name": "language_data.txt", + "kind": "LanguageData", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_report_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_report_files.json new file mode 100644 index 000000000000..24b41a48bcb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_report_files.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'DatasetReport'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_datasets.json new file mode 100644 index 000000000000..eaab758ced4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_datasets.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "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" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint.json new file mode 100644 index 000000000000..5d861ed7b2e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_log.json new file mode 100644 index 000000000000..6d87f13a4ab2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_log.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_logs.json new file mode 100644 index 000000000000..6c5e59279812 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_logs.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoints.json new file mode 100644 index 000000000000..7b95789f23be --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoints.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_english_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_english_base_models.json new file mode 100644 index 000000000000..43a63f9c99dc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_english_base_models.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "locale%20eq%20'en-US'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation.json new file mode 100644 index 000000000000..fe2023e32424 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "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": "Evaluation of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_file.json new file mode 100644 index 000000000000..f5d0fa14de06 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_files.json new file mode 100644 index 000000000000..5a51ed3395ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_files.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a", + "name": "mywavefile1.wav.model1_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model1_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations.json new file mode 100644 index 000000000000..9e0facaa4f97 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "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": "Evaluation of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "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": "Evaluation of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations_with_status_running.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations_with_status_running.json new file mode 100644 index 000000000000..cea52ccbe8bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations_with_status_running.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/f85a328c-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.89, + "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, + "wordErrorRate2": 0.98, + "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 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_failed_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_failed_transcriptions.json new file mode 100644 index 000000000000..1f20e3a904b2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_failed_transcriptions.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Failed'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model.json new file mode 100644 index 000000000000..b70d3923cdfa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_file.json new file mode 100644 index 000000000000..d7eb6f82f606 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_files.json new file mode 100644 index 000000000000..25f67bc88f55 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_files.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_manifest.json new file mode 100644 index 000000000000..8b0a567f99d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_manifest.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/02231df2-012f-45d4-9af0-8a3e4ccc877c" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_with_weight.json new file mode 100644 index 000000000000..aac424e7355a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_with_weight.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_not_started_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_not_started_endpoints.json new file mode 100644 index 000000000000..6577132a6818 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_not_started_endpoints.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'NotStarted'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model.json new file mode 100644 index 000000000000..2f07e9e55d1b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/e30f6a27-82be-4cca-9258-0399c70489ff", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "Succeeded", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff", + "result": { + "link": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/be640db7-c44b-47f2-bf6c-47e431d23d63" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model_pending.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model_pending.json new file mode 100644 index 000000000000..180746d579e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model_pending.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project.json new file mode 100644 index 000000000000..2e6762906bab --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_datasets.json new file mode 100644 index 000000000000..360c2bb518d5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_datasets.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "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" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_endpoints.json new file mode 100644 index 000000000000..5b27748bbd12 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_endpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_evaluations.json new file mode 100644 index 000000000000..cf835b16be55 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_evaluations.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "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": "Evaluation of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "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": "Evaluation of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_models.json new file mode 100644 index 000000000000..3d79a1a5c90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_models.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models?skip=2&top=2&filter=status%20eq%20'Running'" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_transcriptions.json new file mode 100644 index 000000000000..15cbe6f25055 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_transcriptions.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "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" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects.json new file mode 100644 index 000000000000..dd0accbcfab6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 3 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects?skip=3&top=3" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects_from_2018_and_2019.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects_from_2018_and_2019.json new file mode 100644 index 000000000000..65c9b99b1107 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects_from_2018_and_2019.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 3, + "filter": "createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2018-03-03T12:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2018-12-19T17:54:57Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-02-01T00:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_running_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_running_models.json new file mode 100644 index 000000000000..fd78a426b801 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_running_models.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models?skip=2&top=2&filter=status%20eq%20'Running'" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..8c2907544038 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_dataset_locales.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "en-US": [ + "Acoustic", + "Language", + "Pronunciation", + "AudioFiles", + "LanguageMarkdown" + ], + "de-DE": [ + "Acoustic", + "Language", + "AudioFiles" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_endpoint_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_evaluations_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_evaluations_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_model_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_project_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_project_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_transcription_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription.json new file mode 100644 index 000000000000..2c12db4e7cd1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "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" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_file.json new file mode 100644 index 000000000000..ef808a3e40c6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files.json new file mode 100644 index 000000000000..7051221e8550 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef", + "name": "mywavefile2.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files_filtered_by_name.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files_filtered_by_name.json new file mode 100644 index 000000000000..faa6dbc7fac9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files_filtered_by_name.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "name%20eq%20'mywavefile1.wav.json'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcriptions.json new file mode 100644 index 000000000000..483bee215b91 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcriptions.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "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" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hook.json new file mode 100644 index 000000000000..5a57a39389ac --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hook.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks.json new file mode 100644 index 000000000000..22edfd5e434b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2019-02-11T00:00:00Z", + "lastActionDateTime": "2019-02-28T00:00:00Z", + "status": "Succeeded" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks_from_march_2020.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks_from_march_2020.json new file mode 100644 index 000000000000..b62fb607d172 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks_from_march_2020.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "A test web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-11T14:13:12Z", + "lastActionDateTime": "2020-03-11T14:13:12Z", + "status": "Succeeded" + }, + { + "displayName": "Beta version web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-21T09:07:43Z", + "lastActionDateTime": "2020-03-21T09:07:43Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/ping_web_hook.json new file mode 100644 index 000000000000..c5754949767f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/ping_web_hook.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/test_web_hook.json new file mode 100644 index 000000000000..47ce05014dc8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/test_web_hook.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_dataset.json new file mode 100644 index 000000000000..1b54ffd1c984 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_dataset.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "datasetUpdate": { + "displayName": "Updated dataset name", + "description": "Updated dataset description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_endpoint.json new file mode 100644 index 000000000000..5237c6294005 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_endpoint.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endpointUpdate": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "properties": { + "contentLoggingEnabled": true + }, + "displayName": "Updated endpoint with new model", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_evaluation.json new file mode 100644 index 000000000000..f337de02cb88 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_evaluation.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "evaluationUpdate": { + "displayName": "Updated evaluation", + "description": "Updated evaluation description" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "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": "Evaluation of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_model.json new file mode 100644 index 000000000000..a3078bbbf6bb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_model.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelUpdate": { + "displayName": "Language model update", + "description": "This is a language model update", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_project.json new file mode 100644 index 000000000000..080a2e6c23ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_project.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "projectUpdate": { + "displayName": "My updated speech project", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_transcription.json new file mode 100644 index 000000000000..2b847b8148ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_transcription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "transcriptionUpdate": { + "displayName": "Updated transcription name", + "description": "Updated transcription description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "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" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_web_hook.json new file mode 100644 index 000000000000..47514faa1737 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_web_hook.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d", + "webHookUpdate": { + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "events": { + "evaluationCreation": true, + "evaluationProcessing": true, + "evaluationCompletion": true, + "evaluationDeletion": true + }, + "webUrl": "https://contoso.com/call/me/back", + "displayName": "TranscriptionCompletionWebHook", + "description": "I registered this URL to get a POST request for each completed transcription.", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_block.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_block.json new file mode 100644 index 000000000000..61041ac3785c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_block.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockid": "AAE=", + "body": "{binary}" + }, + "responses": { + "201": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_dataset.json new file mode 100644 index 000000000000..3114be1f2e5e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_dataset.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "project": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "Content-Type": "multipart/form-data", + "displayName": "My speech dataset name", + "description": "My speech dataset description", + "locale": "en-us", + "kind": "Acoustic", + "customProperties": "{ \"property\": \"true\" }", + "email": "info@contoso.com" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/speechtotext.json new file mode 100644 index 000000000000..1e7a4aab001b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/speechtotext.json @@ -0,0 +1,6810 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API version 3.2", + "description": "Speech Services API version 3.2.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://learn.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "3.2" + }, + "paths": { + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for datasets.", + "operationId": "Datasets_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatasetLocales" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_dataset_locales.json" + } + } + } + }, + "/datasets": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of datasets for the authenticated subscription.", + "operationId": "Datasets_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n -Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_datasets.json" + }, + "Get all acoustic datasets": { + "$ref": "./examples/get_acoustic_datasets.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads and creates a new dataset by getting the data from a specified URL or starts waiting for data blocks to be uploaded.", + "operationId": "Datasets_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "dataset", + "description": "Definition for the new dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/Dataset" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a dataset with content url": { + "$ref": "./examples/create_dataset_with_content_url.json" + }, + "Create dataset from data blocks": { + "$ref": "./examples/create_dataset_with_blocks.json" + } + } + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "Datasets_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a dataset": { + "$ref": "./examples/get_dataset.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Updates the mutable details of the dataset identified by its ID.", + "operationId": "Datasets_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "datasetUpdate", + "description": "The updated values for the dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a dataset": { + "$ref": "./examples/update_dataset.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Deletes the specified dataset.", + "operationId": "Datasets_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The dataset was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } + } + }, + "/datasets/{id}/blocks": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the list of uploaded blocks for this dataset.", + "operationId": "Datasets_GetBlocks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UploadedBlocks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get uploaded blocks for dataset": { + "$ref": "./examples/get_dataset_blocks.json" + } + } + }, + "put": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Upload a block of data for the dataset. The maximum size of the block is 8MiB.", + "operationId": "Datasets_UploadBlock", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "blockid", + "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. Note that the Base64 string must be URL-encoded.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "The data block was uploaded successfully." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Upload a block for a dataset": { + "$ref": "./examples/upload_block.json" + } + } + } + }, + "/datasets/upload": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads data and creates a new dataset.", + "operationId": "Datasets_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "formData", + "name": "project", + "description": "The optional string representation of the url of a project. If set, the dataset will be associated with that project.", + "type": "string" + }, + { + "in": "formData", + "name": "displayName", + "description": "The name of this dataset.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "description", + "description": "Optional description of this dataset.", + "type": "string" + }, + { + "in": "formData", + "name": "locale", + "description": "The locale of this dataset.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "kind", + "description": "The kind of the dataset. Possible values are \"Language\", \"Acoustic\", \"Pronunciation\", \"AudioFiles\", \"LanguageMarkdown\", \"OutputFormatting\".", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "customProperties", + "description": "The optional custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.", + "type": "string" + }, + { + "in": "formData", + "name": "data", + "description": "For acoustic datasets, a zip file containing the audio data and a text file containing the transcriptions for the audio data. For language datasets, a text file containing the language or pronunciation data. Required in both cases.", + "type": "file" + }, + { + "in": "formData", + "name": "email", + "description": "An optional string containing the email address to send email notifications to in case the operation completes. The value will be removed after successfully sending the email.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "Upload a dataset": { + "$ref": "./examples/upload_dataset.json" + } + } + } + }, + "/datasets/{id}/blocks:commit": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Commit block list to complete the upload of the dataset.", + "operationId": "Datasets_CommitBlocks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "blockList", + "description": "The list of blocks that compile the dataset.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CommitBlocksEntry" + } + } + } + ], + "responses": { + "200": { + "description": "The block list is accepted and the data import process can continue." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Commit uploaded blocks to dataset": { + "$ref": "./examples/commit_block_list.json" + } + } + } + }, + "/datasets/{id}/files": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the files of the dataset identified by the given ID.", + "operationId": "Datasets_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_dataset_files.json" + }, + "Get all dataset report files": { + "$ref": "./examples/get_dataset_report_files.json" + } + } + } + }, + "/datasets/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets one specific file (identified with fileId) from a dataset (identified with id).", + "operationId": "Datasets_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_dataset_file.json" + } + } + } + }, + "/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "Endpoints_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_endpoint_locales.json" + } + } + } + }, + "/endpoints": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoints for the authenticated subscription.", + "operationId": "Endpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + }, + "Get all queued endpoints.": { + "$ref": "./examples/get_not_started_endpoints.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "Endpoints_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "endpoint", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create an endpoint": { + "$ref": "./examples/create_endpoint.json" + } + } + } + }, + "/endpoints/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the endpoint identified by the given ID.", + "operationId": "Endpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint": { + "$ref": "./examples/get_endpoint.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint identified by the given ID.", + "operationId": "Endpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model endpoint was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint": { + "$ref": "./examples/delete_endpoint.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Updates the metadata of the endpoint identified by the given ID.", + "operationId": "Endpoints_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "endpointUpdate", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update an endpoint": { + "$ref": "./examples/update_endpoint.json" + } + } + } + }, + "/endpoints/{id}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored for a given endpoint.", + "operationId": "Endpoints_ListLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoint logs": { + "$ref": "./examples/get_endpoint_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.", + "description": "The deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all endpoint logs": { + "$ref": "./examples/delete_endpoint_logs.json" + } + } + } + }, + "/endpoints/{id}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for a given endpoint.", + "operationId": "Endpoints_GetLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint log": { + "$ref": "./examples/get_endpoint_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored for a given endpoint.", + "operationId": "Endpoints_DeleteLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint log": { + "$ref": "./examples/delete_endpoint_log.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_ListBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all base model logs": { + "$ref": "./examples/get_base_model_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored when using the default base model of a given language. It deletes all logs before (and including) a specific day.", + "description": "Deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all base model logs": { + "$ref": "./examples/delete_base_model_logs.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for the default base model in a given language.", + "operationId": "Endpoints_GetBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model log": { + "$ref": "./examples/get_base_model_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_DeleteBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a base model log": { + "$ref": "./examples/delete_base_model_log.json" + } + } + } + }, + "/evaluations/locales": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets a list of supported locales for evaluations.", + "operationId": "Evaluations_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_evaluations_locales.json" + } + } + } + }, + "/evaluations": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the list of evaluations for the authenticated subscription.", + "operationId": "Evaluations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My evaluation'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_evaluations.json" + }, + "Get all evaluations with where status is equal to 'Running'": { + "$ref": "./examples/get_evaluations_with_status_running.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Creates a new evaluation.", + "operationId": "Evaluations_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "evaluation", + "description": "The details of the new evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/Evaluation" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a evaluation": { + "$ref": "./examples/create_evaluation.json" + } + } + } + }, + "/evaluations/{id}/files": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the files of the evaluation identified by the given ID.", + "operationId": "Evaluations_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_evaluation_files.json" + } + } + } + }, + "/evaluations/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets one specific file (identified with fileId) from an evaluation (identified with id).", + "operationId": "Evaluations_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_evaluation_file.json" + } + } + } + }, + "/evaluations/{id}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the evaluation identified by the given ID.", + "operationId": "Evaluations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a evaluation": { + "$ref": "./examples/get_evaluation.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Updates the mutable details of the evaluation identified by its id.", + "operationId": "Evaluations_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "evaluationUpdate", + "description": "The object containing the updated fields of the evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a evaluation": { + "$ref": "./examples/update_evaluation.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Deletes the evaluation identified by the given ID.", + "operationId": "Evaluations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The evaluation was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a evaluation": { + "$ref": "./examples/delete_evaluation.json" + } + } + } + }, + "/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "Models_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_model_locales.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of custom models for the authenticated subscription.", + "operationId": "Models_ListCustomModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models in state 'Running'": { + "$ref": "./examples/get_running_models.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "Models_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "model", + "description": "The details of the new model.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomModel" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a model": { + "$ref": "./examples/create_model.json" + }, + "Create a model with custom model weight": { + "$ref": "./examples/create_model_with_weight.json" + } + } + } + }, + "/models/base": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of base models for the authenticated subscription.", + "operationId": "Models_ListBaseModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available base models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedBaseModels" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all english base models": { + "$ref": "./examples/get_english_base_models.json" + } + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "Models_GetCustomModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model": { + "$ref": "./examples/get_model.json" + }, + "Get a model with custom model weight": { + "$ref": "./examples/get_model_with_weight.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "Models_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "modelUpdate", + "description": "The updated values for the model.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a model": { + "$ref": "./examples/update_model.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Deletes the model identified by the given ID.", + "operationId": "Models_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a model": { + "$ref": "./examples/delete_model.json" + } + } + } + }, + "/models/base/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the base model identified by the given ID.", + "operationId": "Models_GetBaseModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the base model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseModel" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model": { + "$ref": "./examples/get_base_model.json" + } + } + } + }, + "/models/{id}:copy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Copies a model from one subscription to another.", + "description": "This method can be used to copy a model from this speech resource to a target one.\r\nThe authorization is obtained on the target speech resource.\r\nOnly custom models can be copied to another speech resource.", + "operationId": "Models_Copy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model that will be copied.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "modelCopyAuthorization", + "description": "The body contains the authorization to copy to the target speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + } + ], + "responses": { + "202": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + }, + "Operation-Location": { + "description": "The location of the operation to track progress.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Copy a model from source resource to target resource": { + "$ref": "./examples/copy_model_with_authorization.json" + } + } + } + }, + "/models:authorizecopy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Allows another speech resource (source) to copy a model to this speech resource (target).", + "description": "This method can be used to allow copying a model from another speech resource.\r\nOnly custom models can be copied from another speech resource.", + "operationId": "Models_AuthorizeCopy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "modelCopyAuthorizationDefinition", + "description": "The body contains the Azure Resource ID of the source speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorizationDefinition" + } + } + ], + "responses": { + "200": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a copy model authorization on target resource": { + "$ref": "./examples/create_copy_model_authorization.json" + } + } + } + }, + "/models/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this model which can be used in an on-premise container.", + "operationId": "Models_GetCustomModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model manifest": { + "$ref": "./examples/get_model_manifest.json" + } + } + } + }, + "/models/base/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this base model which can be used in an on-premise container.", + "operationId": "Models_GetBaseModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model manifest": { + "$ref": "./examples/get_base_model_manifest.json" + } + } + } + }, + "/models/{id}/files": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the files of the model identified by the given ID.", + "operationId": "Models_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_model_files.json" + } + } + } + }, + "/models/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets one specific file (identified with fileId) from a model (identified with id).", + "operationId": "Models_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_model_file.json" + } + } + } + }, + "/operations/models/copy/{id}": { + "get": { + "tags": [ + "Custom Speech operations:" + ], + "summary": "Gets the operation identified by the given ID.", + "operationId": "Operations_GetModelCopy", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the operation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get model copy operation pending": { + "$ref": "./examples/get_operation_copy_model_pending.json" + }, + "Get model copy operation": { + "$ref": "./examples/get_operation_copy_model.json" + } + } + } + }, + "/projects/locales": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of supported locales.", + "operationId": "Projects_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_project_locales.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of projects for the authenticated subscription.", + "operationId": "Projects_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available projects.\r\n - Supported properties: displayName, description, createdDateTime, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My test'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedProjects" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all projects": { + "$ref": "./examples/get_projects.json" + }, + "Get all projects created in 2018 or 2019": { + "$ref": "./examples/get_projects_from_2018_and_2019.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Creates a new project.", + "operationId": "Projects_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "project", + "description": "The details of the project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Project" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a project": { + "$ref": "./examples/create_project.json" + } + } + } + }, + "/projects/{id}": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the project identified by the given ID.", + "operationId": "Projects_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a project": { + "$ref": "./examples/get_project.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Updates the project identified by the given ID.", + "operationId": "Projects_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "projectUpdate", + "description": "The updated values for the project.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a project": { + "$ref": "./examples/update_project.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Deletes the project identified by the given ID.", + "operationId": "Projects_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The project was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a project": { + "$ref": "./examples/delete_project.json" + } + } + } + }, + "/projects/{id}/evaluations": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of evaluations for specified project.", + "operationId": "Projects_ListEvaluations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example\r\n filter=displayName eq 'My evaluation'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_project_evaluations.json" + } + } + } + }, + "/projects/{id}/datasets": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of datasets for specified project.", + "operationId": "Projects_ListDatasets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_project_datasets.json" + } + } + } + }, + "/projects/{id}/endpoints": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of endpoints for specified project.", + "operationId": "Projects_ListEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_project_endpoints.json" + } + } + } + }, + "/projects/{id}/models": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of models for specified project.", + "operationId": "Projects_ListModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models": { + "$ref": "./examples/get_project_models.json" + } + } + } + }, + "/projects/{id}/transcriptions": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of transcriptions for specified project.", + "operationId": "Projects_ListTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_project_transcriptions.json" + } + } + } + }, + "/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "Transcriptions_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_transcription_locales.json" + } + } + } + }, + "/transcriptions": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of transcriptions for the authenticated subscription.", + "operationId": "Transcriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + }, + "Get all failed transcriptions": { + "$ref": "./examples/get_failed_transcriptions.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Creates a new transcription.", + "operationId": "Transcriptions_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "transcription", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/Transcription" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a transcription for URIs": { + "$ref": "./examples/create_uri_transcription.json" + }, + "Create a transcription with basic two-speaker diarization": { + "$ref": "./examples/create_simple_diarization_transcription.json" + }, + "Create a transcription with multispeaker diarization": { + "$ref": "./examples/create_multispeaker_diarization_transcription.json" + }, + "Create a transcription with language identification": { + "$ref": "./examples/create_lid_transcription.json" + }, + "Create a transcription from blob container": { + "$ref": "./examples/create_container_transcription.json" + } + } + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "Transcriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a transcription": { + "$ref": "./examples/get_transcription.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Updates the mutable details of the transcription identified by its ID.", + "operationId": "Transcriptions_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "transcriptionUpdate", + "description": "The updated values for the transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/TranscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "Transcriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The transcription was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a transcription": { + "$ref": "./examples/delete_transcription.json" + } + } + } + }, + "/transcriptions/{id}/files": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the files of the transcription identified by the given ID.", + "operationId": "Transcriptions_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav.json' and kind eq 'Transcription'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_transcription_files.json" + }, + "Get all transcription files the name of which starts with the specified string": { + "$ref": "./examples/get_transcription_files_filtered_by_name.json" + } + } + } + }, + "/transcriptions/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets one specific file (identified with fileId) from a transcription (identified with id).", + "operationId": "Transcriptions_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_transcription_file.json" + } + } + } + }, + "/webhooks": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the list of web hooks for the authenticated subscription.", + "operationId": "WebHooks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available hooks.\r\n Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'test'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebHooks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all web hooks": { + "$ref": "./examples/get_web_hooks.json" + }, + "Get all web hooks created in 03/2020 ordered by their name": { + "$ref": "./examples/get_web_hooks_from_march_2020.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Creates a new web hook.", + "description": "If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with\r\nthe secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nWhen calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event\r\ntypes. There will be one request per registered event type.\r\n \r\nAfter successfully registering the web hook, it will not be usable until a challenge/response is completed. To do this, a request with the event type\r\nchallenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken\r\nquery parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "webHook", + "description": "The details of the new web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHook" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a web hook": { + "$ref": "./examples/create_web_hook.json" + } + } + } + }, + "/webhooks/{id}": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the web hook identified by the given ID.", + "operationId": "WebHooks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a web hook": { + "$ref": "./examples/get_web_hook.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Updates the web hook identified by the given ID.", + "description": "If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature\r\nheaders. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash\r\nwill be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nIf the URL changes, the web hook will stop receiving events until a\r\nchallenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken.\r\nRespond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response\r\nis successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "webHookUpdate", + "description": "The updated values for the web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHookUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a web hook": { + "$ref": "./examples/update_web_hook.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Deletes the web hook identified by the given ID.", + "operationId": "WebHooks_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The web hook was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a web hook": { + "$ref": "./examples/delete_web_hook.json" + } + } + } + }, + "/webhooks/{id}:ping": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a ping event to the registered URL.", + "description": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.\r\nThe Swagger Schema ID of the model is WebHookV3.\r\n \r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with\r\na secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Ping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "Started trying to send a ping request to the web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Ping a web hook": { + "$ref": "./examples/ping_web_hook.json" + } + } + } + }, + "/webhooks/{id}:test": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a request for each registered event type to the registered URL.", + "description": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,\r\nthe POST will respond with 204. If a test request can be made, it will respond with 200.\r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.\r\nIf the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Test", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "A test request with the last entity is sent to the registered web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No entity could be found for any event type, so no test request is sent to the registered web hook." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Test a web hook": { + "$ref": "./examples/test_web_hook.json" + } + } + } + } + }, + "definitions": { + "BaseModel": { + "title": "BaseModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/BaseModelLinks" + }, + "properties": { + "$ref": "#/definitions/BaseModelProperties" + } + } + }, + "BaseModelDeprecationDates": { + "title": "BaseModelDeprecationDates", + "type": "object", + "properties": { + "adaptationDateTime": { + "format": "date-time", + "description": "The date when adaptation becomes deprecated.", + "type": "string", + "readOnly": true + }, + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelFeatures": { + "title": "BaseModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "properties": { + "supportsAdaptationsWith": { + "description": "Supported dataset kinds to adapt the model.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetKind" + }, + "readOnly": true + } + } + }, + "BaseModelLinks": { + "title": "BaseModelLinks", + "type": "object", + "properties": { + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelProperties": { + "title": "BaseModelProperties", + "type": "object", + "properties": { + "deprecationDates": { + "$ref": "#/definitions/BaseModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/BaseModelFeatures" + }, + "chargeForAdaptation": { + "description": "A value indicating whether model adaptation is charged.", + "type": "boolean", + "readOnly": true + } + } + }, + "BlockKind": { + "title": "BlockKind", + "description": "Type of data block.", + "enum": [ + "Committed", + "Uncommitted", + "Latest" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockKind", + "modelAsString": true, + "values": [ + { + "value": "Committed", + "description": "A data block from the committed block list." + }, + { + "value": "Uncommitted", + "description": "A data block from the uncommitted block list." + }, + { + "value": "Latest", + "description": "A data block from the uncommitted block list, if present, otherwise from the committed block list." + } + ] + } + }, + "CommitBlocksEntry": { + "title": "CommitBlocksEntry", + "description": "Entry of the commit block list.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/BlockKind" + }, + "id": { + "type": "string" + } + } + }, + "CustomModel": { + "title": "CustomModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/CustomModelLinks" + }, + "properties": { + "$ref": "#/definitions/CustomModelProperties" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/EntityReference" + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityReference" + } + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CustomModelDeprecationDates": { + "title": "CustomModelDeprecationDates", + "type": "object", + "properties": { + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelFeatures": { + "title": "CustomModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "readOnly": true + }, + "CustomModelLinks": { + "title": "CustomModelLinks", + "type": "object", + "properties": { + "copy": { + "format": "uri", + "description": "The location to the model copy action. See operation \"Models_Copy\" for more details.", + "type": "string", + "readOnly": true + }, + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Models_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelProperties": { + "title": "CustomModelProperties", + "type": "object", + "properties": { + "customModelWeightPercent": { + "format": "int32", + "description": "The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model).\r\nWhen this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight).\r\nStart without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "deprecationDates": { + "$ref": "#/definitions/CustomModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/CustomModelFeatures" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "Dataset": { + "title": "Dataset", + "required": [ + "displayName", + "kind", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/DatasetLinks" + }, + "properties": { + "$ref": "#/definitions/DatasetProperties" + }, + "kind": { + "$ref": "#/definitions/DatasetKind" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "contentUrl": { + "format": "uri", + "description": "The URL of the data for the dataset.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "DatasetKind": { + "title": "DatasetKind", + "description": "Type of data import.", + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles", + "LanguageMarkdown", + "OutputFormatting" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": true, + "values": [ + { + "value": "Language", + "description": "A language dataset." + }, + { + "value": "Acoustic", + "description": "An acoustic dataset." + }, + { + "value": "Pronunciation", + "description": "A pronunciation dataset." + }, + { + "value": "AudioFiles", + "description": "An audio files dataset." + }, + { + "value": "LanguageMarkdown", + "description": "A language markdown dataset." + }, + { + "value": "OutputFormatting", + "description": "Dataset that contains rules to customize inverse text normalization, capitalization, reformulation, profanity and also defines tests for dataset validation" + } + ] + } + }, + "DatasetLinks": { + "title": "DatasetLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Datasets_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "commitBlocks": { + "format": "uri", + "description": "The location to commit the list of blocks when uploading a dataset using blocks. See operation \"Datasets_CommitBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "listBlocks": { + "format": "uri", + "description": "The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation \"Datasets_GetBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "uploadBlocks": { + "format": "uri", + "description": "The location to upload blocks to when uploading a dataset using blocks. See operation \"Datasets_UploadBlock\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/DatasetKind" + } + } + }, + "DatasetProperties": { + "title": "DatasetProperties", + "type": "object", + "properties": { + "textNormalizationKind": { + "$ref": "#/definitions/TextNormalizationKind" + }, + "acceptedLineCount": { + "format": "int32", + "description": "The number of lines accepted for this data set.", + "type": "integer", + "readOnly": true + }, + "rejectedLineCount": { + "format": "int32", + "description": "The number of lines rejected for this data set.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "DatasetUpdate": { + "title": "DatasetUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "DetailedErrorCode": { + "title": "DetailedErrorCode", + "description": "Detailed error code enum.", + "enum": [ + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "DataImportFailed", + "InUseViolation", + "InvalidLocale", + "InvalidBaseModel", + "InvalidAdaptationMapping", + "InvalidDataset", + "InvalidTest", + "FailedDataset", + "InvalidModel", + "InvalidTranscription", + "InvalidPayload", + "InvalidParameter", + "EndpointWithoutLogging", + "InvalidPermissions", + "InvalidPrerequisite", + "InvalidProductId", + "InvalidSubscription", + "InvalidProject", + "InvalidProjectKind", + "InvalidRecordingsUri", + "OnlyOneOfUrlsOrContainerOrDataset", + "ExceededNumberOfRecordingsUris", + "InvalidChannels", + "ModelMismatch", + "ProjectGenderMismatch", + "ModelDeprecated", + "ModelExists", + "ModelNotDeployable", + "EndpointNotUpdatable", + "SingleDefaultEndpoint", + "EndpointCannotBeDefault", + "InvalidModelUri", + "SubscriptionNotFound", + "QuotaViolation", + "UnsupportedDelta", + "UnsupportedFilter", + "UnsupportedPagination", + "UnsupportedDynamicConfiguration", + "UnsupportedOrderBy", + "NoUtf8WithBom", + "ModelDeploymentNotCompleteState", + "SkuLimitsExist", + "DeployingFailedModel", + "UnsupportedTimeRange", + "InvalidLogDate", + "InvalidLogId", + "InvalidLogStartTime", + "InvalidLogEndTime", + "InvalidTopForLogs", + "InvalidSkipTokenForLogs", + "DeleteNotAllowed", + "Forbidden", + "DeployNotAllowed", + "UnexpectedError", + "InvalidCollection", + "InvalidCallbackUri", + "InvalidSasValidityDuration", + "InaccessibleCustomerStorage", + "UnsupportedClassBasedAdaptation", + "InvalidWebHookEventKind", + "InvalidTimeToLive", + "InvalidSourceAzureResourceId", + "ModelCopyAuthorizationExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "DetailedErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidParameterValue", + "description": "Invalid parameter value." + }, + { + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format." + }, + { + "value": "EmptyRequest", + "description": "Empty Request." + }, + { + "value": "MissingInputRecords", + "description": "Missing Input Records." + }, + { + "value": "InvalidDocument", + "description": "Invalid Document." + }, + { + "value": "ModelVersionIncorrect", + "description": "Model Version Incorrect." + }, + { + "value": "InvalidDocumentBatch", + "description": "Invalid Document Batch." + }, + { + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code." + }, + { + "value": "DataImportFailed", + "description": "Data import failed." + }, + { + "value": "InUseViolation", + "description": "In use violation." + }, + { + "value": "InvalidLocale", + "description": "Invalid locale." + }, + { + "value": "InvalidBaseModel", + "description": "Invalid base model." + }, + { + "value": "InvalidAdaptationMapping", + "description": "Invalid adaptation mapping." + }, + { + "value": "InvalidDataset", + "description": "Invalid dataset." + }, + { + "value": "InvalidTest", + "description": "Invalid test." + }, + { + "value": "FailedDataset", + "description": "Failed dataset." + }, + { + "value": "InvalidModel", + "description": "Invalid model." + }, + { + "value": "InvalidTranscription", + "description": "Invalid transcription." + }, + { + "value": "InvalidPayload", + "description": "Invalid payload." + }, + { + "value": "InvalidParameter", + "description": "Invalid parameter." + }, + { + "value": "EndpointWithoutLogging", + "description": "Endpoint without logging." + }, + { + "value": "InvalidPermissions", + "description": "Invalid permissions." + }, + { + "value": "InvalidPrerequisite", + "description": "Invalid prerequisite." + }, + { + "value": "InvalidProductId", + "description": "Invalid product id." + }, + { + "value": "InvalidSubscription", + "description": "Invalid subscription." + }, + { + "value": "InvalidProject", + "description": "Invalid project." + }, + { + "value": "InvalidProjectKind", + "description": "Invalid project kind." + }, + { + "value": "InvalidRecordingsUri", + "description": "Invalid recordings uri." + }, + { + "value": "OnlyOneOfUrlsOrContainerOrDataset", + "description": "Only one of urls or container or dataset." + }, + { + "value": "ExceededNumberOfRecordingsUris", + "description": "Exceeded number of recordings uris." + }, + { + "value": "InvalidChannels", + "description": "Invalid channels." + }, + { + "value": "ModelMismatch", + "description": "Model mismatch." + }, + { + "value": "ProjectGenderMismatch", + "description": "Project gender mismatch." + }, + { + "value": "ModelDeprecated", + "description": "Model deprecated." + }, + { + "value": "ModelExists", + "description": "Model exists." + }, + { + "value": "ModelNotDeployable", + "description": "Model not deployable." + }, + { + "value": "EndpointNotUpdatable", + "description": "Endpoint not updatable." + }, + { + "value": "SingleDefaultEndpoint", + "description": "Single default endpoint." + }, + { + "value": "EndpointCannotBeDefault", + "description": "Endpoint cannot be default." + }, + { + "value": "InvalidModelUri", + "description": "Invalid model uri." + }, + { + "value": "SubscriptionNotFound", + "description": "Subscription not found." + }, + { + "value": "QuotaViolation", + "description": "Quota violation." + }, + { + "value": "UnsupportedDelta", + "description": "Unsupported delta." + }, + { + "value": "UnsupportedFilter", + "description": "Unsupported filter." + }, + { + "value": "UnsupportedPagination", + "description": "Unsupported pagination." + }, + { + "value": "UnsupportedDynamicConfiguration", + "description": "Unsupported dynamic configuration." + }, + { + "value": "UnsupportedOrderBy", + "description": "Unsupported order by." + }, + { + "value": "NoUtf8WithBom", + "description": "No utf8 with bom." + }, + { + "value": "ModelDeploymentNotCompleteState", + "description": "Model deployment not complete state." + }, + { + "value": "SkuLimitsExist", + "description": "Sku limits exist." + }, + { + "value": "DeployingFailedModel", + "description": "Deploying failed model." + }, + { + "value": "UnsupportedTimeRange", + "description": "Unsupported time range." + }, + { + "value": "InvalidLogDate", + "description": "Invalid log date." + }, + { + "value": "InvalidLogId", + "description": "Invalid log id." + }, + { + "value": "InvalidLogStartTime", + "description": "Invalid log start time." + }, + { + "value": "InvalidLogEndTime", + "description": "Invalid log end time." + }, + { + "value": "InvalidTopForLogs", + "description": "Invalid top for logs." + }, + { + "value": "InvalidSkipTokenForLogs", + "description": "Invalid skip token for logs." + }, + { + "value": "DeleteNotAllowed", + "description": "Delete not allowed." + }, + { + "value": "Forbidden", + "description": "Forbidden." + }, + { + "value": "DeployNotAllowed", + "description": "Deploy not allowed." + }, + { + "value": "UnexpectedError", + "description": "Unexpected error." + }, + { + "value": "InvalidCollection", + "description": "Invalid collection." + }, + { + "value": "InvalidCallbackUri", + "description": "Invalid callback uri." + }, + { + "value": "InvalidSasValidityDuration", + "description": "Invalid sas validity duration." + }, + { + "value": "InaccessibleCustomerStorage", + "description": "Inaccessible customer storage." + }, + { + "value": "UnsupportedClassBasedAdaptation", + "description": "Unsupported class based adaptation." + }, + { + "value": "InvalidWebHookEventKind", + "description": "Invalid web hook event kind." + }, + { + "value": "InvalidTimeToLive", + "description": "Invalid time to live." + }, + { + "value": "InvalidSourceAzureResourceId", + "description": "Invalid source Azure resource ID." + }, + { + "value": "ModelCopyAuthorizationExpired", + "description": "Expired ModelCopyAuthorization." + } + ] + } + }, + "DiarizationProperties": { + "title": "DiarizationProperties", + "required": [ + "speakers" + ], + "type": "object", + "properties": { + "speakers": { + "$ref": "#/definitions/DiarizationSpeakersProperties" + } + } + }, + "DiarizationSpeakersProperties": { + "title": "DiarizationSpeakersProperties", + "type": "object", + "properties": { + "minCount": { + "format": "int32", + "description": "A hint for the minimum number of speakers for diarization. Must be smaller than or equal to the maxSpeakers property.", + "minimum": 1, + "type": "integer" + }, + "maxCount": { + "format": "int32", + "description": "The maximum number of speakers for diarization. Must be less than 36 and larger than or equal to the minSpeakers property.", + "minimum": 1, + "type": "integer" + } + } + }, + "EditsSummary": { + "title": "EditsSummary", + "type": "object", + "properties": { + "numberOfEdits": { + "format": "int32", + "description": "The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "integer", + "readOnly": true + }, + "percentageOfAllEdits": { + "format": "double", + "description": "The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "number", + "readOnly": true + } + }, + "readOnly": true + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/EndpointLinks" + }, + "properties": { + "$ref": "#/definitions/EndpointProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "text": { + "description": "The text used to adapt a language model for this endpoint.", + "type": "string" + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EndpointLinks": { + "title": "EndpointLinks", + "type": "object", + "properties": { + "restInteractive": { + "format": "uri", + "description": "The REST endpoint for short requests up to 15 seconds.", + "type": "string", + "readOnly": true + }, + "restConversation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds.", + "type": "string", + "readOnly": true + }, + "restDictation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks.", + "type": "string", + "readOnly": true + }, + "webSocketInteractive": { + "format": "uri", + "description": "The Speech SDK endpoint for short requests up to 15 seconds with a single final result.", + "type": "string", + "readOnly": true + }, + "webSocketConversation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results.", + "type": "string", + "readOnly": true + }, + "webSocketDictation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks.", + "type": "string", + "readOnly": true + }, + "logs": { + "format": "uri", + "description": "The audio and transcription logs for this endpoint. See operation \"Endpoints_ListLogs\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EndpointProperties": { + "title": "EndpointProperties", + "type": "object", + "properties": { + "loggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "timeToLive": { + "description": "How long the endpoint will be kept in the system. Once the endpoint reaches the time to live\r\nafter completion (successful or failed) it will be automatically deleted. Not setting this value or setting\r\nto 0 will disable automatic deletion. The longest supported duration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "EndpointPropertiesUpdate": { + "title": "EndpointPropertiesUpdate", + "type": "object", + "properties": { + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions)\r\nis being used for a deployment.", + "type": "boolean" + } + } + }, + "EndpointUpdate": { + "title": "EndpointUpdate", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "properties": { + "$ref": "#/definitions/EndpointPropertiesUpdate" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EntityError": { + "title": "EntityError", + "type": "object", + "properties": { + "code": { + "description": "The code of this error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message for this error.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EntityReference": { + "title": "EntityReference", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of the referenced entity.", + "type": "string" + } + } + }, + "Error": { + "title": "Error", + "description": "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "High level error codes.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound", + "PipelineError", + "Conflict", + "InternalCommunicationFailed", + "Forbidden", + "NotAllowed", + "Unauthorized", + "UnsupportedMediaType", + "TooManyRequests", + "UnprocessableEntity" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidRequest", + "description": "Representing the invalid request error code." + }, + { + "value": "InvalidArgument", + "description": "Representing the invalid argument error code." + }, + { + "value": "InternalServerError", + "description": "Representing the internal server error error code." + }, + { + "value": "ServiceUnavailable", + "description": "Representing the service unavailable error code." + }, + { + "value": "NotFound", + "description": "Representing the not found error code." + }, + { + "value": "PipelineError", + "description": "Representing the pipeline error error code." + }, + { + "value": "Conflict", + "description": "Representing the conflict error code." + }, + { + "value": "InternalCommunicationFailed", + "description": "Representing the internal communication failed error code." + }, + { + "value": "Forbidden", + "description": "Representing the forbidden error code." + }, + { + "value": "NotAllowed", + "description": "Representing the not allowed error code." + }, + { + "value": "Unauthorized", + "description": "Representing the unauthorized error code." + }, + { + "value": "UnsupportedMediaType", + "description": "Representing the unsupported media type error code." + }, + { + "value": "TooManyRequests", + "description": "Representing the too many requests error code." + }, + { + "value": "UnprocessableEntity", + "description": "Representing the unprocessable entity error code." + } + ] + } + }, + "Evaluation": { + "title": "Evaluation", + "required": [ + "dataset", + "displayName", + "locale", + "model1", + "model2" + ], + "type": "object", + "properties": { + "model1": { + "$ref": "#/definitions/EntityReference" + }, + "model2": { + "$ref": "#/definitions/EntityReference" + }, + "transcription1": { + "$ref": "#/definitions/EntityReference" + }, + "transcription2": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "links": { + "$ref": "#/definitions/EvaluationLinks" + }, + "properties": { + "$ref": "#/definitions/EvaluationProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EvaluationLinks": { + "title": "EvaluationLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Evaluations_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EvaluationProperties": { + "title": "EvaluationProperties", + "type": "object", + "properties": { + "wordErrorRate1": { + "format": "double", + "description": "The word error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate1": { + "format": "double", + "description": "The sentence error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate1": { + "format": "double", + "description": "The optional token error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceCount1": { + "format": "int32", + "description": "The number of processed sentences by model1.", + "type": "integer", + "readOnly": true + }, + "wordCount1": { + "format": "int32", + "description": "The number of processed words by model1.", + "type": "integer", + "readOnly": true + }, + "correctWordCount1": { + "format": "int32", + "description": "The number of correctly recognized words by model1.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount1": { + "format": "int32", + "description": "Optional the number of processed tokens by model1.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount1": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model1.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors1": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "wordErrorRate2": { + "format": "double", + "description": "The word error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate2": { + "format": "double", + "description": "The sentence error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate2": { + "format": "double", + "description": "The optional token error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceCount2": { + "format": "int32", + "description": "The number of processed sentences by model2.", + "type": "integer", + "readOnly": true + }, + "wordCount2": { + "format": "int32", + "description": "The number of processed words by model2.", + "type": "integer", + "readOnly": true + }, + "correctWordCount2": { + "format": "int32", + "description": "The number of correctly recognized words by model2.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount2": { + "format": "int32", + "description": "The optional number of processed tokens by model2.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount2": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model2.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors2": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + }, + "readOnly": true + }, + "EvaluationUpdate": { + "title": "EvaluationUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "File": { + "title": "File", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/FileKind" + }, + "links": { + "$ref": "#/definitions/FileLinks" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/FileProperties" + }, + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "FileKind": { + "title": "FileKind", + "description": "Type of data.", + "enum": [ + "DatasetReport", + "Audio", + "LanguageData", + "PronunciationData", + "AcousticDataArchive", + "AcousticDataTranscriptionV2", + "Transcription", + "TranscriptionReport", + "EvaluationDetails", + "ModelReport", + "OutputFormattingData" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileKind", + "modelAsString": true, + "values": [ + { + "value": "DatasetReport", + "description": "Type of data is dataset report." + }, + { + "value": "Audio", + "description": "Type of data is audio." + }, + { + "value": "LanguageData", + "description": "Type of data is language data." + }, + { + "value": "PronunciationData", + "description": "Type of data is pronunciation data." + }, + { + "value": "AcousticDataArchive", + "description": "Type of data is acoustic data archive." + }, + { + "value": "AcousticDataTranscriptionV2", + "description": "Type of data is acoustic data transcription v2." + }, + { + "value": "Transcription", + "description": "Type of data is transcription." + }, + { + "value": "TranscriptionReport", + "description": "Type of data is transcription report." + }, + { + "value": "EvaluationDetails", + "description": "Type of data is evaluation details." + }, + { + "value": "ModelReport", + "description": "Type of data is model report." + }, + { + "value": "OutputFormattingData", + "description": "Type of data is output formatting input file." + } + ] + } + }, + "FileLinks": { + "title": "FileLinks", + "type": "object", + "properties": { + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "FileProperties": { + "title": "FileProperties", + "type": "object", + "properties": { + "size": { + "format": "int64", + "description": "The size of the data in bytes.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The duration in case this file is an audio file. The duration is encoded as ISO 8601\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + } + } + }, + "InnerError": { + "title": "InnerError", + "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/DetailedErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "LanguageIdentificationMode": { + "title": "LanguageIdentificationMode", + "description": "The mode used for language identification.", + "default": "Continuous", + "enum": [ + "Continuous", + "Single" + ], + "type": "string", + "x-ms-enum": { + "name": "LanguageIdentificationMode", + "modelAsString": true, + "values": [ + { + "value": "Continuous", + "description": "Continuous language identification (Default)." + }, + { + "value": "Single", + "description": "Single language identification." + } + ] + } + }, + "LanguageIdentificationProperties": { + "title": "LanguageIdentificationProperties", + "required": [ + "candidateLocales" + ], + "type": "object", + "properties": { + "mode": { + "$ref": "#/definitions/LanguageIdentificationMode" + }, + "candidateLocales": { + "description": "The candidate locales for language identification (example [\"en-US\", \"de-DE\", \"es-ES\"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded.", + "type": "array", + "items": { + "type": "string" + } + }, + "speechModelMapping": { + "description": "An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used.\r\nKeys must be locales contained in the candidate locales, values are entities for models of the respective locales.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EntityReference" + } + } + } + }, + "ModelCopyAuthorization": { + "title": "ModelCopyAuthorization", + "required": [ + "expirationDateTime", + "id", + "sourceResourceId", + "targetResourceEndpoint", + "targetResourceId", + "targetResourceRegion" + ], + "type": "object", + "properties": { + "targetResourceRegion": { + "description": "The region (aka location) of the target speech resource (e.g., westus2).", + "minLength": 1, + "type": "string" + }, + "targetResourceId": { + "description": "The Azure Resource ID of the target speech resource.", + "minLength": 1, + "type": "string" + }, + "targetResourceEndpoint": { + "description": "The endpoint (base url) of the target resource (with custom domain name when it is used).", + "minLength": 1, + "type": "string" + }, + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date of this copy authorization.", + "type": "string" + }, + "id": { + "description": "The ID of this copy authorization.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelCopyAuthorizationDefinition": { + "title": "ModelCopyAuthorizationDefinition", + "required": [ + "sourceResourceId" + ], + "type": "object", + "properties": { + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelFile": { + "title": "ModelFile", + "type": "object", + "properties": { + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "ModelManifest": { + "title": "ModelManifest", + "required": [ + "model", + "modelFiles", + "properties" + ], + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "modelFiles": { + "description": "The model files of this model.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFile" + } + }, + "properties": { + "description": "The configuration for running this model in a container.", + "type": "object", + "additionalProperties": {} + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "Operation": { + "title": "Operation", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this Operation.", + "type": "string" + }, + "result": { + "$ref": "#/definitions/OperationResult" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "OperationResult": { + "title": "OperationResult", + "type": "object", + "properties": { + "link": { + "format": "uri", + "description": "The link to the result of the operation.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "OutputFormatType": { + "title": "OutputFormatType", + "enum": [ + "Lexical", + "Display" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputFormatType", + "modelAsString": true, + "values": [ + { + "value": "Lexical", + "description": "Model provides the transcription output without formatting." + }, + { + "value": "Display", + "description": "Model supports display formatting transcriptions output or endpoints." + } + ] + } + }, + "PaginatedBaseModels": { + "title": "PaginatedBaseModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedCustomModels": { + "title": "PaginatedCustomModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedDatasets": { + "title": "PaginatedDatasets", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEndpoints": { + "title": "PaginatedEndpoints", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEvaluations": { + "title": "PaginatedEvaluations", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedFiles": { + "title": "PaginatedFiles", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedProjects": { + "title": "PaginatedProjects", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedTranscriptions": { + "title": "PaginatedTranscriptions", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Transcription" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedWebHooks": { + "title": "PaginatedWebHooks", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/WebHook" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "ProfanityFilterMode": { + "title": "ProfanityFilterMode", + "description": "Mode of profanity filtering.", + "enum": [ + "None", + "Removed", + "Tags", + "Masked" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfanityFilterMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Disable profanity filtering." + }, + { + "value": "Removed", + "description": "Remove profanity." + }, + { + "value": "Tags", + "description": "Add \"profanity\" XML tags</Profanity>" + }, + { + "value": "Masked", + "description": "Mask the profanity with * except of the first letter, e.g., f***" + } + ] + } + }, + "Project": { + "title": "Project", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/ProjectLinks" + }, + "properties": { + "$ref": "#/definitions/ProjectProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "ProjectLinks": { + "title": "ProjectLinks", + "type": "object", + "properties": { + "evaluations": { + "format": "uri", + "description": "The location to get a list of all evaluations of this project. See operation \"Projects_ListEvaluations\" for more details.", + "type": "string", + "readOnly": true + }, + "datasets": { + "format": "uri", + "description": "The location to get a list of all datasets of this project. See operation \"Projects_ListDatasets\" for more details.", + "type": "string", + "readOnly": true + }, + "models": { + "format": "uri", + "description": "The location to get a list of all models of this project. See operation \"Projects_ListModels\" for more details.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "format": "uri", + "description": "The location to get a list of all endpoints of this project. See operation \"Projects_ListEndpoints\" for more details.", + "type": "string", + "readOnly": true + }, + "transcriptions": { + "format": "uri", + "description": "The location to get a list of all transcriptions of this project. See operation \"Projects_ListTranscriptions\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "ProjectProperties": { + "title": "ProjectProperties", + "type": "object", + "properties": { + "datasetCount": { + "format": "int32", + "description": "The number of datasets associated to this project.", + "type": "integer", + "readOnly": true + }, + "evaluationCount": { + "format": "int32", + "description": "The number of evaluations associated to this project.", + "type": "integer", + "readOnly": true + }, + "modelCount": { + "format": "int32", + "description": "The number of models associated to this project.", + "type": "integer", + "readOnly": true + }, + "transcriptionCount": { + "format": "int32", + "description": "The number of transcriptions associated to this project.", + "type": "integer", + "readOnly": true + }, + "endpointCount": { + "format": "int32", + "description": "The number of endpoints associated to this project.", + "type": "integer", + "readOnly": true + } + }, + "readOnly": true + }, + "ProjectUpdate": { + "title": "ProjectUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PunctuationMode": { + "title": "PunctuationMode", + "description": "The mode used for punctuation.", + "enum": [ + "None", + "Dictated", + "Automatic", + "DictatedAndAutomatic" + ], + "type": "string", + "x-ms-enum": { + "name": "PunctuationMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "No punctuation." + }, + { + "value": "Dictated", + "description": "Dictated punctuation marks only, i.e., explicit punctuation." + }, + { + "value": "Automatic", + "description": "Automatic punctuation." + }, + { + "value": "DictatedAndAutomatic", + "description": "Dictated punctuation marks or automatic punctuation." + } + ] + } + }, + "ResponseBlock": { + "title": "ResponseBlock", + "description": "ResponseBlock.", + "type": "object", + "properties": { + "name": { + "description": "The name of the block.", + "type": "string" + }, + "size": { + "format": "int32", + "description": "The size of the block.", + "type": "integer" + } + } + }, + "SharedModel": { + "title": "SharedModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "SharedModelFeatures": { + "title": "SharedModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "properties": { + "supportsTranscriptions": { + "description": "A value indicating whether batch transcription is supported.", + "type": "boolean", + "readOnly": true + }, + "supportsEndpoints": { + "description": "A value indicating whether creation of endpoints for live transcription is supported.", + "type": "boolean", + "readOnly": true + }, + "supportsTranscriptionsOnSpeechContainers": { + "description": "A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.", + "type": "boolean", + "readOnly": true + }, + "supportedOutputFormats": { + "description": "Supported output formats.", + "type": "array", + "items": { + "$ref": "#/definitions/OutputFormatType" + }, + "readOnly": true + } + } + }, + "Status": { + "title": "Status", + "description": "Describe the current state of the API.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The long running operation has not yet started." + }, + { + "value": "Running", + "description": "The long running operation is currently processing." + }, + { + "value": "Succeeded", + "description": "The long running operation has successfully completed." + }, + { + "value": "Failed", + "description": "The long running operation has failed." + } + ] + } + }, + "TextNormalizationKind": { + "title": "TextNormalizationKind", + "description": "The kind of text normalization.", + "enum": [ + "Default", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "TextNormalizationKind", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US)." + }, + { + "value": "None", + "description": "No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload." + } + ] + } + }, + "TokenErrorDetails": { + "title": "TokenErrorDetails", + "type": "object", + "properties": { + "punctuation": { + "$ref": "#/definitions/EditsSummary" + }, + "capitalization": { + "$ref": "#/definitions/EditsSummary" + }, + "inverseTextNormalization": { + "$ref": "#/definitions/EditsSummary" + }, + "lexical": { + "$ref": "#/definitions/EditsSummary" + }, + "others": { + "$ref": "#/definitions/EditsSummary" + } + }, + "readOnly": true + }, + "Transcription": { + "title": "Transcription", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/TranscriptionLinks" + }, + "properties": { + "$ref": "#/definitions/TranscriptionProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "contentUrls": { + "description": "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.", + "type": "array", + "items": { + "format": "uri", + "type": "string" + } + }, + "contentContainerUrl": { + "format": "uri", + "description": "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "TranscriptionLinks": { + "title": "TranscriptionLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Transcriptions_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "TranscriptionProperties": { + "title": "TranscriptionProperties", + "type": "object", + "properties": { + "wordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps are requested. The default value is\r\n`false`.", + "type": "boolean" + }, + "displayFormWordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps for the display form are requested. The default value is `false`.", + "type": "boolean" + }, + "duration": { + "description": "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "channels": { + "description": "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "destinationContainerUrl": { + "format": "uri", + "description": "The requested destination container.\r\n### Remarks ###\r\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\r\ntranscription will be deleted normally, but the data stored in the destination container, including\r\ntranscription results, will remain untouched, because no delete permissions are required for this\r\ncontainer.
\r\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\r\ninstead of `destinationContainerUrl`, where blobs can be cleaned up.", + "type": "string" + }, + "punctuationMode": { + "$ref": "#/definitions/PunctuationMode" + }, + "profanityFilterMode": { + "$ref": "#/definitions/ProfanityFilterMode" + }, + "timeToLive": { + "description": "How long the transcription will be kept in the system after it has completed. Once the\r\ntranscription reaches the time to live after completion (successful or failed) it will be automatically\r\ndeleted. Not setting this value or setting it to 0 will disable automatic deletion. The longest supported\r\nduration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "diarizationEnabled": { + "description": "A value indicating whether diarization (speaker identification) is requested. The default value\r\nis `false`.\r\nIf this field is set to true and the improved diarization system is configured by specifying\r\n`DiarizationProperties`, the improved diarization system will provide diarization for a configurable\r\nrange of speakers.\r\nIf this field is set to true and the improved diarization system is not enabled (not specifying\r\n`DiarizationProperties`), the basic diarization system will distinguish between up to two speakers.\r\nNo extra charges are applied for the basic diarization.\r\n \r\nThe basic diarization system is deprecated and will be removed in the next major version of the API.\r\nThis `diarizationEnabled` setting will also be removed.", + "type": "boolean" + }, + "diarization": { + "$ref": "#/definitions/DiarizationProperties" + }, + "languageIdentification": { + "$ref": "#/definitions/LanguageIdentificationProperties" + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "UploadedBlocks": { + "title": "UploadedBlocks", + "description": "List of uploaded blocks.", + "type": "object", + "properties": { + "committedBlocks": { + "description": "The block description of blocks already committed.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + }, + "uncommittedBlocks": { + "description": "The block description of blocks not committed to the blob.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + } + } + }, + "WebHook": { + "title": "WebHook", + "required": [ + "displayName", + "events", + "webUrl" + ], + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "links": { + "$ref": "#/definitions/WebHookLinks" + }, + "properties": { + "$ref": "#/definitions/WebHookProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebHookEvents": { + "title": "WebHookEvents", + "type": "object", + "properties": { + "datasetCreation": { + "type": "boolean" + }, + "datasetProcessing": { + "type": "boolean" + }, + "datasetCompletion": { + "type": "boolean" + }, + "datasetDeletion": { + "type": "boolean" + }, + "modelCreation": { + "type": "boolean" + }, + "modelProcessing": { + "type": "boolean" + }, + "modelCompletion": { + "type": "boolean" + }, + "modelDeletion": { + "type": "boolean" + }, + "evaluationCreation": { + "type": "boolean" + }, + "evaluationProcessing": { + "type": "boolean" + }, + "evaluationCompletion": { + "type": "boolean" + }, + "evaluationDeletion": { + "type": "boolean" + }, + "transcriptionCreation": { + "type": "boolean" + }, + "transcriptionProcessing": { + "type": "boolean" + }, + "transcriptionCompletion": { + "type": "boolean" + }, + "transcriptionDeletion": { + "type": "boolean" + }, + "endpointCreation": { + "type": "boolean" + }, + "endpointProcessing": { + "type": "boolean" + }, + "endpointCompletion": { + "type": "boolean" + }, + "endpointDeletion": { + "type": "boolean" + }, + "ping": { + "type": "boolean" + }, + "challenge": { + "type": "boolean" + } + } + }, + "WebHookLinks": { + "title": "WebHookLinks", + "type": "object", + "properties": { + "ping": { + "format": "uri", + "description": "The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation \"WebHooks_Ping\" for more details.", + "type": "string", + "readOnly": true + }, + "test": { + "format": "uri", + "description": "The URL that can be used sending test events to the registered URL of a web hook registration. See operation \"WebHooks_Test\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "WebHookProperties": { + "title": "WebHookProperties", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/EntityError" + }, + "apiVersion": { + "description": "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\r\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\r\nthe web hook will be disabled.", + "type": "string", + "readOnly": true + }, + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookPropertiesUpdate": { + "title": "WebHookPropertiesUpdate", + "type": "object", + "properties": { + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookUpdate": { + "title": "WebHookUpdate", + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/WebHookPropertiesUpdate" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "skipQueryParameter": { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "topQueryParameter": { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "sasValidityQueryParameter": { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "api_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services account key here." + }, + "token": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" + } + }, + "security": [ + { + "api_key": [] + }, + { + "token": [] + } + ], + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/speechtotext/v3.2", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +}