diff --git a/custom-words.txt b/custom-words.txt index fa51d74e9023..df8d2309a62a 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -15,6 +15,7 @@ accesskey accesspoint accountid accountname +accuracytests ACLs aclspec acquisitionid @@ -135,6 +136,7 @@ asyncinfo asyncoperation atascada attestationcollateral +audiodata Auditd australiaeast australiasoutheast @@ -380,6 +382,7 @@ contoso contosodataset contosomedia cooldown +copyto Corda coreml Corent @@ -765,6 +768,7 @@ hdinsight Headnode healthbot healthcareapis +healthstatus Heatbeat heatmap HHMM @@ -935,6 +939,7 @@ labelset labservices LACNIC Lajolla +languagedata largefacelists largepersongroups lastfile @@ -1666,6 +1671,8 @@ sparkr sparql SPDX specversion +speechtotext +speechservicesmanagement SQLAG sqldatabase SQLDB @@ -1721,6 +1728,7 @@ streamingjobs streamingservice subcause subcomponent +subcomponents subdir subdomain subexpressions diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md new file mode 100644 index 000000000000..e8a06eb3cb7e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -0,0 +1,51 @@ +# Cognitive Services SpeechToText SDKs + +> see https://aka.ms/autorest + +Configuration for generating SpeechToText SDK. + +The current release for the SpeechToText is `release_3_0`. + +``` yaml +tag: release_3_0 +add-credentials: true +openapi-type: data-plane +``` + +# Releases + +## SpeechToText 2.0 +These settings apply only when `--tag=release_2_0` is specified on the command line. + +``` yaml $(tag) == 'release_2_0' +input-file: stable/v2.0/speechtotext.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Changing casing will break existing clients/consumers + - suppress: GuidUsage + reason: Changing casing will break existing clients/consumers +``` + +--- + +## SpeechToText 3.0 +These settings apply only when `--tag=release_3_0` is specified on the command line. + +``` yaml $(tag) == 'release_3_0' +input-file: stable/v3.0/speechtotext.json +``` + +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. +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json new file mode 100644 index 000000000000..9bc9ce00b979 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "testDefinition": { + "models": [ + { + "id": "685b5e3a-e5c0-45ae-8c8a-86b50cabd3ea" + }, + { + "id": "15fde948-c8b7-4484-a610-07d4ddc69fad" + } + ], + "dataset": { + "id": "5d2b9da6-e687-47b3-bb71-140a4d1ca3d5" + }, + "name": "Accuracy test", + "description": "This is an accuracy test" + }, + "Content-Type": "application/json" + }, + "responses": { + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json new file mode 100644 index 000000000000..ee2d13154fb6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointDefinition": { + "models": [ + { + "id": "d7295e5c-089f-44ab-99b0-73c17ffc3ae0" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "locale": "en-US", + "name": "Speech endpoint definition", + "description": "This is a speech endpoint" + }, + "Content-Type": "application/json" + }, + "responses": { + "202": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json new file mode 100644 index 000000000000..1a69056a1d0e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endpointDataDefinition": { + "startDate": "2018-12-08T00:00:00Z", + "endDate": "2019-01-07T00:00:00Z" + }, + "Content-Type": "application/json" + }, + "responses": { + "202": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json new file mode 100644 index 000000000000..4e0280838aa1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "modelDefinition": { + "modelKind": "Language", + "baseModel": { + "id": "f2842de0-fc16-4858-8391-e3fd1efb6980" + }, + "datasets": [ + { + "id": "a712c3ba-0e49-4059-a17f-0465426514c7" + } + ], + "locale": "en-US", + "name": "Language model", + "description": "This is a language model definition" + }, + "Content-Type": "application/json" + }, + "responses": { + "202": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json new file mode 100644 index 000000000000..1cee7268bde9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "recordingsUrl": "https://contoso.com/mystoragelocation", + "models": [], + "locale": "en-US", + "name": "Transcription using locale en-US", + "description": "An optional description of the transcription.", + "properties": { + "AddWordLevelTimestamps": "True", + "AddDiarization": "True", + "AddSentiment": "True", + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "202": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json new file mode 100644 index 000000000000..6a23ec68bb10 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060" + }, + "responses": { + "204": { + "headers": {} + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json new file mode 100644 index 000000000000..d1baf9a62850 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json new file mode 100644 index 000000000000..5b48ffeff607 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {} + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json new file mode 100644 index 000000000000..c49f415cdae2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {} + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json new file mode 100644 index 000000000000..5dd8874d89e4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json new file mode 100644 index 000000000000..bc37f17e93a5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json new file mode 100644 index 000000000000..9c36f0caaa9d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json new file mode 100644 index 000000000000..c836c7b3e810 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "name": "Accuracy test" + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json new file mode 100644 index 000000000000..0946c13b8a19 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "name": "Accuracy test" + } + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json new file mode 100644 index 000000000000..f30f112057da --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json new file mode 100644 index 000000000000..1534811bb997 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + { + "dataImportKind": "Pronunciation", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "c0a2c730-19f7-4a78-9e0f-f8b6efa5f0a5", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Pronunciation dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/PronunciationData/71e831ef-ba18-4fbb-8559-cea56f98284f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=5b69ed9e-e848-461b-8f4e-78851bc82f07" + } + }, + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json new file mode 100644 index 000000000000..ce9aa549e1a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "8fa0669c-a01e-4693-ae3a-93baf40f26d9", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json new file mode 100644 index 000000000000..c7a2bbf02745 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "startDate": "2018-12-08T00:00:00Z", + "endDate": "2019-01-07T00:00:00Z", + "dataUrl": "https://contoso.com/", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded" + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json new file mode 100644 index 000000000000..6c6c78757947 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "startDate": "2018-12-08T00:00:00Z", + "endDate": "2019-01-07T00:00:00Z", + "dataUrl": "https://contoso.com/", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded" + } + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json new file mode 100644 index 000000000000..95c8dd37b8d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "8fa0669c-a01e-4693-ae3a-93baf40f26d9", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json new file mode 100644 index 000000000000..8fd2f2a3809a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json new file mode 100644 index 000000000000..3fac3cba7299 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + }, + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + } + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..11005cadb75d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Acoustic": [ + "en-US" + ], + "Language": [ + "en-US", + "de-DE" + ], + "Pronunciation": [ + "en-US" + ] + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..a65ac640c9ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..200b0762d0ae --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Acoustic": [ + "en-US" + ], + "Language": [ + "en-US", + "de-DE" + ] + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..a65ac640c9ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json new file mode 100644 index 000000000000..0dd12dda929a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "recordingsUrl": "https://contoso.com/", + "reportFileUrl": "https://contoso.com/", + "resultsUrls": { + "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", + "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json new file mode 100644 index 000000000000..7516d4320d80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "recordingsUrl": "https://contoso.com/", + "reportFileUrl": "https://contoso.com/", + "resultsUrls": { + "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", + "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json new file mode 100644 index 000000000000..2626dfc7e8d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", + "testUpdate": { + "name": "Updated test name", + "description": "Updated test description" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "name": "Accuracy test" + } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json new file mode 100644 index 000000000000..efdbcebac377 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "datasetUpdate": { + "name": "Updated dataset name", + "description": "Updated dataset description" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json new file mode 100644 index 000000000000..dd9cf46bb0c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endpointUpdate": { + "name": "Updated speech endpoint", + "description": "Example for an updated speech endpoint" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "8fa0669c-a01e-4693-ae3a-93baf40f26d9", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json new file mode 100644 index 000000000000..49bb4f0d9a2f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelUpdate": { + "name": "Language model update", + "description": "This is a language model update" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json new file mode 100644 index 000000000000..b2b0168dded3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "transcriptionUpdate": { + "name": "Updated transcription name", + "description": "Updated transcription description" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "recordingsUrl": "https://contoso.com/", + "reportFileUrl": "https://contoso.com/", + "resultsUrls": { + "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", + "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json new file mode 100644 index 000000000000..8a30c97431ae --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "name": "My speech dataset name", + "Content-Type": "multipart/form-data", + "description": "My speech dataset description", + "locale": "en-us", + "dataImportKind": "Acoustic", + "properties": "{ \"property\": \"true\" }" + }, + "responses": { + "202": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "415": { + "headers": {}, + "body": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json new file mode 100644 index 000000000000..6598aaae85c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -0,0 +1,5830 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API v2.0", + "description": "Speech Services API v2.0.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://docs.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "v2.0" + }, + "paths": { + "/accuracytests": { + "get": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Gets the list of accuracy tests for the authenticated subscription.", + "operationId": "GetAccuracyTests", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Test" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get all accuracy tests": { + "$ref": "./examples/get_accuracy_tests.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Creates a new accuracy test.", + "operationId": "CreateAccuracyTest", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "testDefinition", + "description": "The details of the new accuracy test.", + "required": true, + "schema": { + "$ref": "#/definitions/TestDefinition" + } + } + ], + "responses": { + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Create an accuracy test": { + "$ref": "./examples/create_accuracy_test.json" + } + } + } + }, + "/accuracytests/{id}": { + "get": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Gets the accuracy test identified by the given ID.", + "operationId": "GetAccuracyTest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the accuracy test.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Test" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get an accuracy test": { + "$ref": "./examples/get_accuracy_test.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Updates the mutable details of the test identified by its id.", + "operationId": "UpdateAccuracyTest", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the accuracy test.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "testUpdate", + "description": "The object containing the updated fields of the test.", + "required": true, + "schema": { + "$ref": "#/definitions/TestUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Test" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Update an accuracy test": { + "$ref": "./examples/update_accuracy_test.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Deletes the accuracy test identified by the given ID.", + "operationId": "DeleteAccuracyTest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the accuracy test.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The test was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Delete an accuracy test": { + "$ref": "./examples/delete_accuracy_test.json" + } + } + } + }, + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for data imports.", + "operationId": "GetSupportedLocalesForDatasets", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatasetLocales" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetDatasets", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_datasets.json" + } + } + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "GetDataset", + "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" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateDataset", + "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": "datasetUpdate", + "description": "The updated values for the dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteDataset", + "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.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } + } + }, + "/datasets/upload": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads data and creates a new dataset.", + "operationId": "UploadDataset", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "formData", + "name": "name", + "description": "The name of this data import (always add this string for any import).", + "type": "string" + }, + { + "in": "formData", + "name": "description", + "description": "Optional description of this data import.", + "type": "string" + }, + { + "in": "formData", + "name": "locale", + "description": "The locale of this data import (always add this string for any import).", + "type": "string" + }, + { + "in": "formData", + "name": "dataImportKind", + "description": "The kind of the data import (always add this string for any import). Possible values are \"Language\", \"Acoustic\", \"Pronunciation\".", + "type": "string" + }, + { + "in": "formData", + "name": "properties", + "description": "Optional properties of this data import (json serialized object with key/values, where all values must be strings)", + "type": "string" + }, + { + "in": "formData", + "name": "audiodata", + "description": "A zip file containing the audio data (this and the audio archive file for acoustic data imports).", + "type": "file" + }, + { + "in": "formData", + "name": "transcriptions", + "description": "A text file containing the transcriptions for the audio data (this and the transcriptions file for acoustic data imports).", + "type": "file" + }, + { + "in": "formData", + "name": "languagedata", + "description": "A text file containing the language or pronunciation data (only this file for language data imports).", + "type": "file" + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "In case the media type of a file part is not supported.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upload a dataset": { + "$ref": "./examples/upload_dataset.json" + } + } + } + }, + "/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "GetSupportedLocalesForEndpoints", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEndpoints", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "CreateEndpoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "endpointDefinition", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechEndpointDefinition" + } + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "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": "GetEndpoint", + "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" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteEndpoint", + "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.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateEndpoint", + "consumes": [ + "application/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/EndpointMetadataUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Update an endpoint": { + "$ref": "./examples/update_endpoint.json" + } + } + } + }, + "/endpoints/{endpointId}/data": { + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the transcriptions and captured audio files associated with the endpoint identified by the given ID.", + "description": "Deletion will happen in the background and can take up to a day.", + "operationId": "DeleteEndpointData", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The endpoint data export tasks were successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Delete the data for an endpoint": { + "$ref": "./examples/delete_endpoint_data.json" + } + } + }, + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoint data export tasks for the authenticated user.", + "operationId": "GetEndpointDataExports", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointData" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get all endpoint data exports": { + "$ref": "./examples/get_endpoint_data_exports.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Create a new endpoint data export task.", + "operationId": "CreateEndpointDataExport", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "endpointDataDefinition", + "description": "The details of the new endpoint data export.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointDataDefinition" + } + } + ], + "responses": { + "202": { + "description": "The response contains the id of the endpoint data export task in the header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create an endpoint data exports": { + "$ref": "./examples/create_endpoint_data_exports.json" + } + } + } + }, + "/endpoints/{endpointId}/data/{id}": { + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint data export task identified by the given ID.", + "operationId": "DeleteEndpointDataExport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint data export.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The endpoint data export task was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Delete a data export for an endpoint": { + "$ref": "./examples/delete_endpoint_data_export.json" + } + } + }, + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the specified endpoint data export task for the authenticated user.", + "operationId": "GetEndpointDataExport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "id", + "description": "The identifier of the data export.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointData" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get an endpoint data export": { + "$ref": "./examples/get_endpoint_data_export.json" + } + } + } + }, + "/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "GetSupportedLocalesForModels", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelLocales" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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 models for the authenticated subscription.", + "operationId": "GetModels", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get all models": { + "$ref": "./examples/get_models.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "CreateModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "modelDefinition", + "description": "The details of the new model.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechModelDefinition" + } + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create a model": { + "$ref": "./examples/create_model.json" + } + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "GetModel", + "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/Model" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get a model": { + "$ref": "./examples/get_model.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "UpdateModel", + "consumes": [ + "application/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/Model" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteModel", + "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.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Delete a model": { + "$ref": "./examples/delete_model.json" + } + } + } + }, + "/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "GetSupportedLocalesForTranscriptions", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of transcriptions that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "take", + "description": "Number of transcriptions that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Transcription" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Creates a new transcription.", + "operationId": "CreateTranscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "transcription", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/TranscriptionDefinition" + } + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create a transcription": { + "$ref": "./examples/create_transcription.json" + } + } + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "GetTranscription", + "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" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateTranscription", + "consumes": [ + "application/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": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "DeleteTranscription", + "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 task was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Delete a transcription": { + "$ref": "./examples/delete_transcription.json" + } + } + } + } + }, + "definitions": { + "Dataset": { + "title": "Dataset", + "required": [ + "dataImportKind", + "id", + "locale", + "name" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "dataImportKind": { + "description": "The kind of the dataset (e.g. acoustic data, language data ...)", + "enum": [ + "Language", + "Acoustic", + "Pronunciation" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": false + } + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "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.", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + } + } + }, + "DatasetIdentity": { + "title": "DatasetIdentity", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + } + } + }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "properties": { + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Pronunciation": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DatasetUpdate": { + "title": "DatasetUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "endpointKind", + "id", + "locale", + "models", + "name" + ], + "type": "object", + "properties": { + "concurrentRecognitions": { + "format": "int32", + "description": "The number of concurrent recognitions the endpoint supports.", + "type": "integer" + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "endpointUrls": { + "description": "The list of endpoint urls.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "endpointKind": { + "description": "The kind of this endpoint (e.g. custom speech).", + "enum": [ + "SpeechRecognition", + "PronunciationScore" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointKind", + "modelAsString": false + } + }, + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + }, + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "models": { + "description": "Information about the deployed models.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "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" + } + } + } + }, + "EndpointData": { + "title": "EndpointData", + "required": [ + "endDate", + "id", + "startDate" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "dataUrl": { + "description": "The resulting data Url for the model deployment.", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + }, + "startDate": { + "format": "date-time", + "description": "The start date of the deployment data export.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The end date of the deployment data export.", + "type": "string" + } + } + }, + "EndpointDataDefinition": { + "title": "EndpointDataDefinition", + "required": [ + "endDate", + "startDate" + ], + "type": "object", + "properties": { + "startDate": { + "format": "date-time", + "description": "The start date of the deployment data export.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The end date of the deployment data export.", + "type": "string" + } + } + }, + "EndpointMetadataUpdate": { + "title": "EndpointMetadataUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "ErrorContent": { + "title": "ErrorContent", + "description": "The interface represents the content of an error response defined in the OneAPI v2.1 documentation.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "details": { + "description": "An array of details representing distinct related errors that occurred during the request.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "$ref": "#/definitions/InnerErrorV2" + }, + "code": { + "description": "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error. It is intended as\r\nan aid to developers and is not suitable for exposure to end users.", + "type": "string" + }, + "target": { + "description": "The target of the particular error (e.g., the name of the property in error).", + "type": "string" + } + } + }, + "ErrorDetail": { + "title": "ErrorDetail", + "description": "An array of implementations of this interface can be used as details for an error.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error. It is intended as\r\nan aid to developers and is not suitable for exposure to end users.", + "type": "string" + }, + "target": { + "description": "The target of the particular error (e.g., the name of the property in error).", + "type": "string" + } + } + }, + "InnerErrorV2": { + "title": "InnerErrorV2", + "description": "An implementation of this interface represents a stage in a stack trace.\r\nIf the error level is the root, the Microsoft.SpeechServices.Http.Dto.IInnerError.Code and the Microsoft.SpeechServices.Http.Dto.IInnerError.InnerError\r\nproperty may be omitted.", + "type": "object", + "properties": { + "code": { + "description": "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InnerErrorV2" + } + } + }, + "Model": { + "title": "Model", + "required": [ + "id", + "locale", + "modelKind", + "name" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "modelKind": { + "description": "The kind of this model (e.g. acoustic, language ...)", + "enum": [ + "Acoustic", + "Language", + "AcousticAndLanguage" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelKind", + "modelAsString": false + } + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/Model" + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + } + } + }, + "ModelIdentity": { + "title": "ModelIdentity", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + } + } + }, + "ModelLocales": { + "title": "ModelLocales", + "type": "object", + "properties": { + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "AcousticAndLanguage": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "SpeechEndpointDefinition": { + "title": "SpeechEndpointDefinition", + "required": [ + "locale", + "models", + "name" + ], + "type": "object", + "properties": { + "concurrentRecognitions": { + "format": "int32", + "description": "The number of concurrent recognitions the endpoint supports.", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "models": { + "description": "Information about the deployed models.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "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" + } + }, + "name": { + "description": "The name of the object.", + "type": "string" + } + } + }, + "SpeechModelDefinition": { + "title": "SpeechModelDefinition", + "required": [ + "locale", + "modelKind", + "name" + ], + "type": "object", + "properties": { + "modelKind": { + "description": "The kind of this model (e.g. acoustic, language ...)", + "enum": [ + "Acoustic", + "Language", + "AcousticAndLanguage" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelKind", + "modelAsString": false + } + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/ModelIdentity" + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetIdentity" + } + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "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" + } + }, + "name": { + "description": "The name of the object.", + "type": "string" + } + } + }, + "Test": { + "title": "Test", + "required": [ + "id", + "models", + "name" + ], + "type": "object", + "properties": { + "resultsUrl": { + "description": "The URL that can be used to download the test results.\r\nEach line in the file represents a tab separated list of filename, reference transcription and decoder output.\r\n \r\nThe URL will only be valid, if the test completed successfully.", + "type": "string", + "readOnly": true + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "wordErrorRate": { + "format": "double", + "description": "The word error rate of the tested model.", + "type": "number", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + }, + "models": { + "description": "Information about the models used for this accuracy test.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "dataset": { + "$ref": "#/definitions/Dataset" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "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" + } + } + } + }, + "TestDefinition": { + "title": "TestDefinition", + "required": [ + "models", + "name" + ], + "type": "object", + "properties": { + "models": { + "description": "Information about the models used for this accuracy test.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "dataset": { + "$ref": "#/definitions/DatasetIdentity" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "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" + } + } + } + }, + "TestUpdate": { + "title": "TestUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "Transcription": { + "title": "Transcription", + "required": [ + "id", + "locale", + "name", + "recordingsUrl" + ], + "type": "object", + "properties": { + "recordingsUrl": { + "type": "string" + }, + "reportFileUrl": { + "type": "string", + "readOnly": true + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "models": { + "description": "The models used in this transcription.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "resultsUrls": { + "description": "The results Urls for the transcription.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "statusMessage": { + "description": "The failure reason for the transcription.", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "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" + } + } + } + }, + "TranscriptionDefinition": { + "title": "TranscriptionDefinition", + "required": [ + "locale", + "name", + "recordingsUrl" + ], + "type": "object", + "properties": { + "recordingsUrl": { + "type": "string" + }, + "models": { + "description": "The models used in this transcription.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "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" + } + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "subscription_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services subscription 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" + } + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/speechtotext/v2.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json new file mode 100644 index 000000000000..80a7eaf783fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelCopy": { + "targetSubscriptionKey": "KeyForTheSubscriptionTheModelIsSupposedToBeCopiedTo" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json new file mode 100644 index 000000000000..1a32cdc6907b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json @@ -0,0 +1,69 @@ +{ + "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": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json new file mode 100644 index 000000000000..49eb3a6574bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json @@ -0,0 +1,80 @@ +{ + "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.0/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": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json new file mode 100644 index 000000000000..f80f6307002b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json @@ -0,0 +1,102 @@ +{ + "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.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json new file mode 100644 index 000000000000..55b1d1f6c98f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json @@ -0,0 +1,86 @@ +{ + "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.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json new file mode 100644 index 000000000000..ae70359d9a72 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json @@ -0,0 +1,68 @@ +{ + "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.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json new file mode 100644 index 000000000000..9c1ee6474499 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json @@ -0,0 +1,90 @@ +{ + "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, + "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.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json new file mode 100644 index 000000000000..be626d7c0e7a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json @@ -0,0 +1,74 @@ +{ + "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": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/hooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/hooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "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" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json new file mode 100644 index 000000000000..38d4ca0605e4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json @@ -0,0 +1,52 @@ +{ + "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": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json new file mode 100644 index 000000000000..55c86a5d8bc5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json new file mode 100644 index 000000000000..61e6ed96c2a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json new file mode 100644 index 000000000000..9f0c26d3fa18 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json new file mode 100644 index 000000000000..233c71c13736 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json @@ -0,0 +1,52 @@ +{ + "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": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json new file mode 100644 index 000000000000..ff96518fa82f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json @@ -0,0 +1,52 @@ +{ + "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": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json new file mode 100644 index 000000000000..d7f856b0d1eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json new file mode 100644 index 000000000000..f20a60c2e2a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json new file mode 100644 index 000000000000..f625f38bd696 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json new file mode 100644 index 000000000000..8a122f914a0c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json new file mode 100644 index 000000000000..e3f3377f9c4c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json new file mode 100644 index 000000000000..9bea763bf362 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json @@ -0,0 +1,68 @@ +{ + "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.0/models/base/827712a5-f942-4997-91c3-7c6cde35600b", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json new file mode 100644 index 000000000000..8841c8c3fe78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "logId": 10, + "$sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json new file mode 100644 index 000000000000..90da33828e38 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "$sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/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.0/endpoints/base/en-us/files/logs?top=2&SkipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json new file mode 100644 index 000000000000..bc104cf762a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json @@ -0,0 +1,92 @@ +{ + "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.0/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 + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json new file mode 100644 index 000000000000..3a59f60963da --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/827712a5-f942-4997-91c3-7c6cde35600b", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/1327b659-83b2-42b5-afd8-184d1e2a1a2e", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/1327b659-83b2-42b5-afd8-184d1e2a1a2e" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "de-DE", + "displayName": "de-DE Base model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json new file mode 100644 index 000000000000..5ae01638b0bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json @@ -0,0 +1,69 @@ +{ + "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.0/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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json new file mode 100644 index 000000000000..f4212dcc2277 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json @@ -0,0 +1,65 @@ +{ + "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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "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" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json new file mode 100644 index 000000000000..f1ba30e215dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json @@ -0,0 +1,84 @@ +{ + "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, + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "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.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/f035cf2d-4051-4131-85e7-97e3a7349c86", + "name": "Name", + "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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json new file mode 100644 index 000000000000..66918b6d761e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b", + "kind": "Pronunciation", + "contentUrl": "https://www.contoso.com/PronunciationData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT10M" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Pronunciation dataset", + "customProperties": { + "CustomProperty": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets?skip=3&top=3" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json new file mode 100644 index 000000000000..f46b912e0a50 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json @@ -0,0 +1,76 @@ +{ + "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.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json new file mode 100644 index 000000000000..3aa8f14a5c40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json @@ -0,0 +1,65 @@ +{ + "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.0/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" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json new file mode 100644 index 000000000000..363fd53e7023 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json @@ -0,0 +1,83 @@ +{ + "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": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/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.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&SkipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json new file mode 100644 index 000000000000..aeab2ba8044f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json new file mode 100644 index 000000000000..5538b3404b22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json @@ -0,0 +1,95 @@ +{ + "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.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json new file mode 100644 index 000000000000..0cc218837ed2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json @@ -0,0 +1,65 @@ +{ + "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.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "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" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json new file mode 100644 index 000000000000..33181fd0550a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json @@ -0,0 +1,83 @@ +{ + "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": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a", + "name": "Name", + "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.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "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.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json new file mode 100644 index 000000000000..2e96aeb25bd9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/bfb375ef-5e20-4f71-8e0c-00fa21ba6477", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json new file mode 100644 index 000000000000..5d5ed377205d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "Healthy" + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json new file mode 100644 index 000000000000..3b09e852b75a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json @@ -0,0 +1,78 @@ +{ + "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.0/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json new file mode 100644 index 000000000000..bc104cf762a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json @@ -0,0 +1,92 @@ +{ + "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.0/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 + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json new file mode 100644 index 000000000000..80409084589a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json new file mode 100644 index 000000000000..006fb32cf234 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json @@ -0,0 +1,71 @@ +{ + "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.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json new file mode 100644 index 000000000000..9668663797fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b", + "kind": "Pronunciation", + "contentUrl": "https://www.contoso.com/PronunciationData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT10M" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Pronunciation dataset", + "customProperties": { + "CustomProperty": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets?skip=3&top=3" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json new file mode 100644 index 000000000000..8a706c722441 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json new file mode 100644 index 000000000000..37a7a1f9f1ab --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/bfb375ef-5e20-4f71-8e0c-00fa21ba6477", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json new file mode 100644 index 000000000000..a73bcd8550ea --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json new file mode 100644 index 000000000000..c8de29e03298 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json new file mode 100644 index 000000000000..ce42e5aefabc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..b910b5b5f1b7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "en-US": [ + "Acoustic", + "Pronunciation", + "AudioFiles" + ], + "de-DE": [ + "Acoustic", + "Language", + "AudioFiles" + ] + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..a65ac640c9ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json new file mode 100644 index 000000000000..a65ac640c9ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..a65ac640c9ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json new file mode 100644 index 000000000000..a65ac640c9ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..a65ac640c9ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json new file mode 100644 index 000000000000..7a72fb77b45b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json @@ -0,0 +1,83 @@ +{ + "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.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json new file mode 100644 index 000000000000..f59eaac60925 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json @@ -0,0 +1,65 @@ +{ + "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.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "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" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json new file mode 100644 index 000000000000..d7e9e1f2582c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json @@ -0,0 +1,83 @@ +{ + "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 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "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.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef", + "name": "Name", + "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.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json new file mode 100644 index 000000000000..7c1afce096d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json new file mode 100644 index 000000000000..9c69871f935e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json @@ -0,0 +1,70 @@ +{ + "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.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "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" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json new file mode 100644 index 000000000000..00851c8e53c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "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" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "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" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/034034ec-2872-43e0-b1e5-f57735e253bf", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "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.0/webhooks?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json new file mode 100644 index 000000000000..b9200fe97a13 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json new file mode 100644 index 000000000000..db331fdce132 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json @@ -0,0 +1,54 @@ +{ + "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": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json new file mode 100644 index 000000000000..1f5dbff0497e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json @@ -0,0 +1,77 @@ +{ + "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.0/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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json new file mode 100644 index 000000000000..d40e3f7cc000 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json @@ -0,0 +1,89 @@ +{ + "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.0/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.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json new file mode 100644 index 000000000000..a5b1928ab0be --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_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", + "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.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json new file mode 100644 index 000000000000..2f2a8ebd7041 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json @@ -0,0 +1,86 @@ +{ + "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.0/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json new file mode 100644 index 000000000000..47c161313eef --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json @@ -0,0 +1,78 @@ +{ + "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.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json new file mode 100644 index 000000000000..0b2ca961d88f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json @@ -0,0 +1,91 @@ +{ + "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.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json new file mode 100644 index 000000000000..0ffcbbf59ffb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json @@ -0,0 +1,88 @@ +{ + "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.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "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" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json new file mode 100644 index 000000000000..75788623be27 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "project": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "415": { + "headers": {}, + "body": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json new file mode 100644 index 000000000000..f116ceaaa168 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -0,0 +1,8075 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API v3.0", + "description": "Speech Services API v3.0.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://docs.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "v3.0" + }, + "paths": { + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for data imports.", + "operationId": "GetSupportedLocalesForDatasets", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatasetLocales" + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetDatasets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_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.", + "operationId": "CreateDataset", + "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 the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Create a dataset": { + "$ref": "./examples/create_dataset.json" + } + } + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "GetDataset", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateDataset", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteDataset", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } + } + }, + "/datasets/upload": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads data and creates a new dataset.", + "operationId": "UploadDatasetFromForm", + "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 data import (required).", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "description", + "description": "Optional description of this data import.", + "type": "string" + }, + { + "in": "formData", + "name": "locale", + "description": "The locale of this data import (required).", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "kind", + "description": "The kind of the data import (required). Possible values are \"Language\", \"Acoustic\", \"Pronunciation\", \"AudioFiles\".", + "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 data imports, a zip file containing the audio data and a text file containing the transcriptions for the audio data. For language data imports, 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 the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "415": { + "description": "In case the media type of a file part is not supported.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "deprecated": true, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Upload a dataset": { + "$ref": "./examples/upload_dataset.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": "GetDatasetFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Number of files that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_dataset_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": "GetDatasetFile", + "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" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetSupportedLocalesForEndpoints", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of endpoints that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of endpoints that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "CreateEndpoint", + "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 the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEndpoint", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteEndpoint", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateEndpoint", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEndpointLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "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" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included (between 1 and 5000).", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteEndpointLogs", + "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, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEndpointLog", + "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" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteEndpointLog", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetBaseModelLogs", + "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": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "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" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included (between 1 and 5000).", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "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, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "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" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetSupportedLocalesForEvaluations", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEvaluations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of evaluations that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of evaluations that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_evaluations.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Creates a new evaluation.", + "operationId": "CreateEvaluation", + "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 the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEvaluationFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Number of files that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEvaluationFile", + "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" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEvaluation", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateEvaluation", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteEvaluation", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetSupportedLocalesForModels", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of models that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of models that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models": { + "$ref": "./examples/get_models.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "CreateModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "model", + "description": "The details of the new model.", + "required": true, + "schema": { + "$ref": "#/definitions/Model" + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Create a model": { + "$ref": "./examples/create_model.json" + } + } + } + }, + "/models/base": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of base models for the authenticated subscription.", + "operationId": "GetBaseModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of base models that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of base models that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedModels" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all base models": { + "$ref": "./examples/get_base_models.json" + } + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "GetModel", + "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/Model" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get a model": { + "$ref": "./examples/get_model.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "UpdateModel", + "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/Model" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteModel", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "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/Model" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get a base model": { + "$ref": "./examples/get_base_model.json" + } + } + } + }, + "/models/{id}/copyto": { + "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 one location to another. If the target subscription\r\nkey belongs to a subscription created for another location, the model will be copied to that location.\r\nOnly adapted models are allowed to copy to another subscription.", + "operationId": "CopyModelToSubscription", + "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": "modelCopy", + "description": "The body contains the subscription key of the target subscription.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopy" + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Copy a model": { + "$ref": "./examples/copy_model.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": "GetModelManifest", + "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" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "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" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Get a base model manifest": { + "$ref": "./examples/get_base_model_manifest.json" + } + } + } + }, + "/projects/locales": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of supported locales.", + "operationId": "GetSupportedProjectLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetProjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of projects that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of projects that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedProjects" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all projects": { + "$ref": "./examples/get_projects.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Creates a new project.", + "operationId": "CreateProject", + "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 the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Project" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetProject", + "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" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateProject", + "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" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteProject", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEvaluationsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of evaluations that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of evaluations that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetDatasetsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetEndpointsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of endpoints that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of endpoints that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetModelsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of models that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of models that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetTranscriptionsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of transcriptions that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of transcriptions that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetSupportedLocalesForTranscriptions", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of transcriptions that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of transcriptions that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Creates a new transcription.", + "operationId": "CreateTranscription", + "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 the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Create a transcription": { + "$ref": "./examples/create_transcription.json" + } + } + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "GetTranscription", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateTranscription", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "DeleteTranscription", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetTranscriptionFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Number of files that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_transcription_files.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": "GetTranscriptionFile", + "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" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetHooks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of hooks that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of hooks that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all web hooks": { + "$ref": "./examples/get_web_hooks.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": "CreateHook", + "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 the location of the entity as header.", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "GetHook", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "UpdateHook", + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "DeleteHook", + "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." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "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": "PingHook", + "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" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "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": "TestHook", + "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" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "204": { + "description": "No entity could be found for any event type, so no test request is sent to the registered web hook." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Test a web hook": { + "$ref": "./examples/test_web_hook.json" + } + } + } + }, + "/healthstatus": { + "get": { + "tags": [ + "Service Health:" + ], + "summary": "Returns the overall health of the service and optionally of the different subcomponents.", + "operationId": "GetHealthStatus", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ], + "x-ms-examples": { + "Gets the health status": { + "$ref": "examples/get_healthstatus.json" + } + } + } + } + }, + "definitions": { + "Component": { + "title": "Component", + "type": "object", + "properties": { + "message": { + "description": "Additional messages about the current service health.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the component.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The health status of this component.", + "enum": [ + "Unhealthy", + "Degraded", + "Healthy" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": false + } + }, + "type": { + "description": "The type of this component.", + "type": "string", + "readOnly": true + } + } + }, + "Dataset": { + "title": "Dataset", + "required": [ + "displayName", + "kind", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/Links" + }, + "properties": { + "$ref": "#/definitions/DatasetProperties" + }, + "kind": { + "description": "The kind of the dataset.", + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": false + } + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "contentUrl": { + "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.", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + } + } + }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": false + } + } + } + }, + "DatasetProperties": { + "title": "DatasetProperties", + "type": "object", + "properties": { + "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": { + "project": { + "$ref": "#/definitions/EntityReference" + }, + "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" + } + } + } + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "project": { + "$ref": "#/definitions/EntityReference" + }, + "links": { + "$ref": "#/definitions/EndpointLinks" + }, + "properties": { + "$ref": "#/definitions/EndpointProperties" + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "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.", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + } + } + }, + "EndpointLinks": { + "title": "EndpointLinks", + "type": "object", + "properties": { + "restInteractive": { + "description": "The REST endpoint for short requests up to 15 seconds.", + "type": "string", + "readOnly": true + }, + "restConversation": { + "description": "The REST endpoint for requests up to 60 seconds.", + "type": "string", + "readOnly": true + }, + "restDictation": { + "description": "The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks.", + "type": "string", + "readOnly": true + }, + "webSocketInteractive": { + "description": "The Speech SDK endpoint for short requests up to 15 seconds with a single final result.", + "type": "string", + "readOnly": true + }, + "webSocketConversation": { + "description": "The Speech SDK endpoint for long requests with multiple final results.", + "type": "string", + "readOnly": true + }, + "webSocketDictation": { + "description": "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks.", + "type": "string", + "readOnly": true + }, + "logs": { + "description": "The audio and transcription logs for this endpoint.", + "type": "string", + "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.\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" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "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" + } + } + } + }, + "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 + } + } + }, + "EntityReference": { + "title": "EntityReference", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "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": { + "title": "ErrorCode", + "description": "High level error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound", + "PipelineError", + "Conflict", + "InternalCommunicationFailed", + "Forbidden", + "NotAllowed", + "Unauthorized", + "UnsupportedMediaType", + "TooManyRequests" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "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" + } + } + }, + "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/Links" + }, + "properties": { + "$ref": "#/definitions/EvaluationProperties" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "self": { + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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.", + "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.", + "type": "string" + } + } + }, + "EvaluationProperties": { + "title": "EvaluationProperties", + "type": "object", + "properties": { + "wordErrorRate2": { + "format": "double", + "description": "The word error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "wordErrorRate1": { + "format": "double", + "description": "The word error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate2": { + "format": "double", + "description": "The sentence 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 + }, + "sentenceErrorRate1": { + "format": "double", + "description": "The sentence 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 + }, + "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" + } + } + }, + "EvaluationUpdate": { + "title": "EvaluationUpdate", + "type": "object", + "properties": { + "project": { + "$ref": "#/definitions/EntityReference" + }, + "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" + } + } + } + }, + "File": { + "title": "File", + "type": "object", + "properties": { + "kind": { + "description": "The kind of this file.", + "enum": [ + "DatasetReport", + "Audio", + "LanguageData", + "PronunciationData", + "AcousticDataArchive", + "AcousticDataTranscriptionV2", + "Transcription", + "TranscriptionReport", + "EvaluationDetails" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileKind", + "modelAsString": true + } + }, + "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": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "FileLinks": { + "title": "FileLinks", + "type": "object", + "properties": { + "contentUrl": { + "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": { + "description": "Detailed error code.", + "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", + "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", + "DeleteNotAllowed", + "Forbidden", + "DeployNotAllowed", + "UnexpectedError", + "InvalidCollection", + "InvalidCallbackUri", + "InvalidSasValidityDuration", + "InaccessibleCustomerStorage", + "UnsupportedClassBasedAdaptation", + "InvalidWebHookEventKind" + ], + "type": "string", + "x-ms-enum": { + "name": "DetailedErrorCode", + "modelAsString": true + } + }, + "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" + } + } + }, + "Links": { + "title": "Links", + "type": "object", + "properties": { + "files": { + "description": "The location to get all files of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "Model": { + "title": "Model", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "project": { + "$ref": "#/definitions/EntityReference" + }, + "links": { + "$ref": "#/definitions/ModelLinks" + }, + "properties": { + "$ref": "#/definitions/ModelProperties" + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "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" + } + }, + "locale": { + "description": "The locale of the contained data.", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + }, + "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" + } + } + } + }, + "ModelCopy": { + "title": "ModelCopy", + "required": [ + "targetSubscriptionKey" + ], + "type": "object", + "properties": { + "targetSubscriptionKey": { + "description": "The subscription key of the subscription that is the target of the copy operation.", + "type": "string" + } + } + }, + "ModelDeprecationDates": { + "title": "ModelDeprecationDates", + "type": "object", + "properties": { + "adaptationDateTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "transcriptionDateTime": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "ModelFile": { + "title": "ModelFile", + "type": "object", + "properties": { + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "contentUrl": { + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "ModelLinks": { + "title": "ModelLinks", + "type": "object", + "properties": { + "manifest": { + "description": "The location to get a manifest for this model to be used in the on-prem container.", + "type": "string", + "readOnly": true + }, + "copyTo": { + "description": "The location to the model copy action.", + "type": "string", + "readOnly": true + } + } + }, + "ModelManifest": { + "title": "ModelManifest", + "required": [ + "model", + "modelFiles", + "properties" + ], + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "modelFiles": { + "description": "The model files, the endpoint requires.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFile" + } + }, + "properties": { + "description": "The configuration of the endpoint.", + "type": "object", + "additionalProperties": { + "title": "Object", + "type": "object" + } + } + } + }, + "ModelProperties": { + "title": "ModelProperties", + "type": "object", + "properties": { + "deprecationDates": { + "$ref": "#/definitions/ModelDeprecationDates" + }, + "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" + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "type": "object", + "properties": { + "project": { + "$ref": "#/definitions/EntityReference" + }, + "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" + } + } + } + }, + "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": { + "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": { + "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": { + "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": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedModels": { + "title": "PaginatedModels", + "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/Model" + }, + "readOnly": true + }, + "@nextLink": { + "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": { + "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": { + "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": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "Project": { + "title": "Project", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/ProjectLinks" + }, + "properties": { + "$ref": "#/definitions/ProjectProperties" + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "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": { + "description": "The location to get a list of all evaluations of this project.", + "type": "string", + "readOnly": true + }, + "datasets": { + "description": "The location to get a list of all datasets of this project.", + "type": "string", + "readOnly": true + }, + "models": { + "description": "The location to get a list of all models of this project.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "description": "The location to get a list of all endpoints of this project.", + "type": "string", + "readOnly": true + }, + "transcriptions": { + "description": "The location to get a list of all transcriptions of this project.", + "type": "string", + "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 + } + } + }, + "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" + } + } + } + }, + "ServiceHealth": { + "title": "ServiceHealth", + "type": "object", + "properties": { + "status": { + "description": "The overall service status.", + "enum": [ + "Unhealthy", + "Degraded", + "Healthy" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": false + } + }, + "message": { + "description": "Additional messages about the current service health.", + "type": "string", + "readOnly": true + }, + "components": { + "description": "Optional subcomponents of this service and their status.", + "type": "array", + "items": { + "$ref": "#/definitions/Component" + }, + "readOnly": true + } + } + }, + "Transcription": { + "title": "Transcription", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/Links" + }, + "properties": { + "$ref": "#/definitions/TranscriptionProperties" + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "contentUrls": { + "description": "A list of content urls to get audio files from for transcription. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.", + "type": "array", + "items": { + "type": "string" + } + }, + "contentContainerUrl": { + "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" + }, + "displayName": { + "description": "The display 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" + } + }, + "locale": { + "description": "The locale of the contained data.", + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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 + } + } + }, + "TranscriptionProperties": { + "title": "TranscriptionProperties", + "type": "object", + "properties": { + "diarizationEnabled": { + "description": "A value indicating whether diarization (speaker separation) is requested.", + "type": "boolean" + }, + "wordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps are requested.", + "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": { + "description": "The requested destination container.", + "type": "string" + }, + "punctuationMode": { + "title": "PunctuationMode", + "description": "The requested punctuation mode.", + "enum": [ + "None", + "Dictated", + "Automatic", + "DictatedAndAutomatic" + ], + "type": "string", + "x-ms-enum": { + "name": "PunctuationMode", + "modelAsString": false + } + }, + "profanityFilterMode": { + "title": "ProfanityFilterMode", + "description": "The requested profanity filter mode.", + "enum": [ + "None", + "Removed", + "Tags", + "Masked" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfanityFilterMode", + "modelAsString": false + } + }, + "timeToLive": { + "description": "How long the transcription will be kept in the system. Once the transcription 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.\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" + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "type": "object", + "properties": { + "project": { + "$ref": "#/definitions/EntityReference" + }, + "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" + } + } + } + }, + "WebHook": { + "title": "WebHook", + "required": [ + "displayName", + "events", + "webUrl" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/WebHookLinks" + }, + "properties": { + "$ref": "#/definitions/WebHookProperties" + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "webUrl": { + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "events": { + "title": "WebHookEvents", + "description": "A value indicating the webhook event kinds.", + "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" + } + } + }, + "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": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "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" + } + } + } + }, + "WebHookLinks": { + "title": "WebHookLinks", + "type": "object", + "properties": { + "ping": { + "description": "The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration.", + "type": "string", + "readOnly": true + }, + "test": { + "description": "The URL that can be used sending test events to the registered URL of a web hook registration.", + "type": "string", + "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": { + "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": { + "title": "WebHookEvents", + "description": "A value indicating the webhook event kinds.", + "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" + } + } + }, + "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" + } + } + } + } + }, + "securityDefinitions": { + "subscription_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services subscription 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" + } + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/speechtotext/v3.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +}