diff --git a/specification/cognitiveservices/data-plane/SpeechServices/readme.go.md b/specification/cognitiveservices/data-plane/SpeechServices/readme.go.md new file mode 100644 index 000000000000..b983efdd92f7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeechServices/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: SpeechServices + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: release_2_0 +``` + +### Tag: release_2_0 and go + +These settings apply only when `--tag=release_2_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_2_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/SpeechServices/readme.md b/specification/cognitiveservices/data-plane/SpeechServices/readme.md new file mode 100644 index 000000000000..71e01746ab41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeechServices/readme.md @@ -0,0 +1,72 @@ +# Cognitive Services SpeechServices REST SDK + +> see https://aka.ms/autorest + +Configuration for generating SpeechServices SDK. + +The current release is `release_2_0`. + +``` yaml + +tag: release_2_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 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/Speech.json +``` + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_speechservices'] +``` + + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + sync-methods: None + license-header: MICROSOFT_MIT_NO_VERSION + azure-arm: false + namespace: Microsoft.Azure.CognitiveServices.SpeechServices + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/SpeechServices/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.cognitiveservices.SpeechServices + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/speechservices + with-optional-parameters: true + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeechServices/readme.nodejs.md b/specification/cognitiveservices/data-plane/SpeechServices/readme.nodejs.md new file mode 100644 index 000000000000..9443a36139cf --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeechServices/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + package-name: azure-cognitiveservices-speechservices + output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesSpeechServices + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeechServices/readme.python.md b/specification/cognitiveservices/data-plane/SpeechServices/readme.python.md new file mode 100644 index 000000000000..6f0eb5fc72a1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeechServices/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + license-header: MICROSOFT_MIT_NO_VERSION + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.speechservices + package-name: azure-cognitiveservices-speechservices + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-speechservices/azure/cognitiveservices/speechservices +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-speechservices +``` diff --git a/specification/cognitiveservices/data-plane/SpeechServices/readme.ruby.md b/specification/cognitiveservices/data-plane/SpeechServices/readme.ruby.md new file mode 100644 index 000000000000..67a1fdf7c66c --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeechServices/readme.ruby.md @@ -0,0 +1,27 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_cognitiveservices_speechservices +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: release_2_0 +``` + +### Tag: release_2_0 and ruby + +These settings apply only when `--tag=release_1_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::SpeechServices::V2_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_SpeechServices/lib +title: "SpeechServicesClient" +``` diff --git a/specification/cognitiveservices/data-plane/SpeechServices/readme.typescript.md b/specification/cognitiveservices/data-plane/SpeechServices/readme.typescript.md new file mode 100644 index 000000000000..30816797cff7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeechServices/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-speechservices" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-speechservices" + azure-arm: false + generate-metadata: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeechServices/stable/v2.0/Speech.json b/specification/cognitiveservices/data-plane/SpeechServices/stable/v2.0/Speech.json new file mode 100644 index 000000000000..784d55ccb3e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeechServices/stable/v2.0/Speech.json @@ -0,0 +1,13585 @@ +{ + "swagger": "2.0", + "info": { + "version": "v2.0", + "title": "Speech Services API v2.0", + "description": "Speech Services API v2.0.", + "contact": { + "name": "Cognitive Services - Speech Services", + "email": "crservice@microsoft.com" + } + }, + "host": "westus.cris.ai", + "schemes": [ + "https" + ], + "paths": { + "/api/speechtotext/v2.0/accuracytests": { + "get": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Gets the list of accuracy tests for the authenticated subscription.", + "operationId": "AccuracyTests_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "187ca2fd-1bde-4cb3-bab8-4f92b5cd8e56", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "983f0403-89a0-49d1-9b2c-bf89c9b69e8a", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "12d47f63-bb84-4baf-a7b1-718f512c8201", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "c93d0931-ba7f-4ca5-b2a9-11fe4bdcf16d", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "75088617-dee2-4657-80de-82bb000c5943", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "id": "932727fb-015c-493b-9e5d-786f7a4e2c89", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "f480788a-0465-496b-907d-bd447c552edd", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "name": "Accuracy test", + "properties": {} + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Creates a new accuracy test.", + "operationId": "AccuracyTest_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "testDefinition", + "in": "body", + "description": "The details of the new accuracy test.", + "required": true, + "schema": { + "$ref": "#/definitions/TestDefinition" + } + } + ], + "responses": { + "204": { + "description": "No Content", + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/accuracytests/{id}": { + "get": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Gets the accuracy test identified by the given ID.", + "operationId": "AccuracyTest_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "87a9234e-79d7-4760-84a1-078ee57ef21a", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "2d51aceb-86f3-400b-9d4f-a46b8c550ad5", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "a41baf79-89f0-45e7-a53f-413f45ad81fe", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "a7daef7e-7dc0-44e8-b317-cdf96cb65347", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "2f0a03b6-b28c-4da4-9a1e-b66d8a97e022", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "id": "9fb1dacd-9d69-46b6-8cf1-16e7f09902a8", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "f1a122fb-dfb6-4763-b844-10473d2c39c2", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "name": "Accuracy test", + "properties": {} + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Deletes the accuracy test identified by the given ID.", + "operationId": "AccuracyTest_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Updates the mutable details of the test identified by its id.", + "operationId": "AccuracyTest_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the accuracy test.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "testUpdate", + "in": "body", + "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" + } + }, + "examples": { + "application/json": { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "90658047-3791-4e82-bebb-08701ecf9204", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "5eaf77e7-5847-4654-8f65-9924952569c2", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "e6a5e9c9-60f6-4b75-9278-ca10a67a83e9", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "ee625acc-d4a0-45cd-88c4-7f176e9c08f1", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "05649460-5d19-4ed0-8692-d2ca7fc7d747", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "id": "811bc783-b423-47d2-b52a-fb7128ca1ae7", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "16100f5b-0530-47fa-95c5-bd4cc97d04ee", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "name": "Accuracy test", + "properties": {} + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/datasets": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of datasets for the authenticated subscription.", + "operationId": "Datasets_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "dataImportKind": "Acoustic", + "id": "6ff902e4-848b-4840-9b25-89a00ebc6488", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + }, + { + "dataImportKind": "Pronunciation", + "id": "117402dc-bed2-4ccb-ae83-11ea88b77494", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Pronunciation dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/PronunciationData/1685fadb-2344-4b28-89b7-5de8aae8c939?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a0c925a2-b7dd-45a8-ba62-d4a6f10153ba" + } + }, + { + "dataImportKind": "Language", + "id": "05a26138-c4ee-49a0-98f7-622bd605d542", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "Dataset_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "dataImportKind": "Acoustic", + "id": "6790ffa9-114b-45d3-9a8b-862681e8b4da", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Deletes the specified dataset.", + "operationId": "Dataset_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "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" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Updates the mutable details of the dataset identified by its ID.", + "operationId": "Dataset_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "datasetUpdate", + "in": "body", + "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" + } + }, + "examples": { + "application/json": { + "dataImportKind": "Acoustic", + "id": "c0a8e65e-e61a-479f-8600-38dd2aaaf4ca", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for data imports.", + "operationId": "SupportedLocalesForDatasets_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IReadOnlyDictionary" + }, + "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" + } + }, + "examples": { + "application/json": { + "Acoustic": [ + "en-US" + ], + "Language": [ + "en-US", + "de-DE" + ], + "Pronunciation": [ + "en-US" + ] + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/datasets/upload": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads data and creates a new dataset.", + "operationId": "Dataset_Upload", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "multipart/form-data" + ], + "produces": [], + "parameters": [ + { + "name": "name", + "in": "formData", + "description": "The name of this data import (always add this string for any import).", + "type": "string" + }, + { + "name": "description", + "in": "formData", + "description": "Optional description of this data import.", + "type": "string" + }, + { + "name": "locale", + "in": "formData", + "description": "The locale of this data import (always add this string for any import).", + "type": "string" + }, + { + "name": "dataImportKind", + "in": "formData", + "description": "The kind of the data import (always add this string for any import).", + "type": "string", + "enum": [ + "None", + "Language", + "Acoustic", + "Pronunciation", + "CustomVoice", + "LanguageGeneration" + ] + }, + { + "name": "properties", + "in": "formData", + "description": "Optional properties of this data import (json serialized object with key/values, where all values must be strings)", + "type": "string" + }, + { + "name": "audiodata", + "in": "formData", + "description": "A zip file containing the audio data (this and the audio archive file for acoustic data imports).", + "type": "file" + }, + { + "name": "transcriptions", + "in": "formData", + "description": "A text file containing the transcriptions for the audio data (this and the transcriptions file for acoustic data imports).", + "type": "file" + }, + { + "name": "languagedata", + "in": "formData", + "description": "A text file containing the language or pronunciation data (only this file for language data imports).", + "type": "file" + } + ], + "responses": { + "201": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/endpoints": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoints for the authenticated subscription.", + "operationId": "Endpoints_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "10e34a82-f4b9-48a4-92c8-ef0d10fdf2dd", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "12f751ac-0c1c-4288-9681-7c523489f16d", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "171e5cd7-510f-4cbf-860d-0eb5f666f303", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "c425edfc-da5e-412b-8d2a-fd73b8e0d9a5", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "b6575af7-0f87-40b2-b0f2-371ed5b291c1", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://fedev.develop2.cris.ai/speech/recognition/interactive/cognitiveservices/v1?cid=77CB309E-5780-4DE4-877E-BE91B66FA548" + }, + "id": "b5be35fa-46e4-4d8f-b6da-c65da569fc99", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "Endpoint_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "endpointDefinition", + "in": "body", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechEndpointDefinition" + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + }, + "503": { + "description": "In case the service is not available.", + "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" + } + }, + "examples": { + "application/json": { + "code": "ServiceUnavailable", + "message": "ServiceUnavailable" + } + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/endpoints/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the endpoint identified by the given ID.", + "operationId": "Endpoint_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "3b2d5507-a967-494a-9882-9b96959907fa", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "d3aa1016-ecd7-442b-9ec3-82afc2f874aa", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "af23f356-61ed-43d9-affd-7b807141d158", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "b0635b5a-485f-4c63-aee0-8897f4dc9b25", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "36a3d6f9-7470-446a-8512-ba91f4773d27", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://fedev.develop2.cris.ai/speech/recognition/interactive/cognitiveservices/v1?cid=77CB309E-5780-4DE4-877E-BE91B66FA548" + }, + "id": "7b6a847b-40ba-4cc1-bef5-3817737ff1aa", + "createdDateTime": "2019-03-20T14:46:18Z", + "lastActionDateTime": "2019-03-20T14:46:18Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint identified by the given ID.", + "operationId": "Endpoint_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Updates the metadata of the endpoint identified by the given ID.", + "operationId": "Endpoint_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "endpointUpdate", + "in": "body", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "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" + } + }, + "examples": { + "application/json": { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "13f60574-2ec1-4b0c-96d4-3a82e02ae867", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "5d113a71-25a8-4be7-bd15-267b468790fc", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "8f729e26-d493-4e32-9d8a-538cb36182ea", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "f23964d0-4ece-4be3-b704-b3327a9910a8", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "7345d3b7-61fa-40c1-ab42-1bdcb2e0a9b8", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://fedev.develop2.cris.ai/speech/recognition/interactive/cognitiveservices/v1?cid=77CB309E-5780-4DE4-877E-BE91B66FA548" + }, + "id": "151d7566-6865-4276-b16f-f7da40026a0e", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "SupportedLocalesForEndpoints_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + "en-US", + "de-DE" + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/endpoints/{endpointId}/data": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoint data export tasks for the authenticated user.", + "operationId": "EndpointDataExports_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "endpointId", + "in": "path", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointData" + } + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a running 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" + } + }, + "examples": { + "application/json": [ + { + "startDate": "2019-02-10T00:00:00Z", + "endDate": "2019-03-12T00:00:00Z", + "dataUrl": "https://contoso.com/", + "id": "aedbc034-5605-4349-87c4-5bb531f5f0a5", + "createdDateTime": "2019-03-12T17:12:19Z", + "lastActionDateTime": "2019-03-12T17:12:19Z", + "status": "Succeeded" + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Create a new endpoint data export task.", + "operationId": "EndpointDataExport_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "endpointId", + "in": "path", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "endpointDataDefinition", + "in": "body", + "description": "The details of the new endpoint data export.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointDataDefinition" + } + } + ], + "responses": { + "201": { + "description": "The response contains the id of the endpoint data export task.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "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": "EndpointData_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "endpointId", + "in": "path", + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/endpoints/{endpointId}/data/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the specified endpoint data export task for the authenticated user.", + "operationId": "EndpointDataExport_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "endpointId", + "in": "path", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "id", + "in": "path", + "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" + } + }, + "examples": { + "application/json": { + "startDate": "2019-02-10T00:00:00Z", + "endDate": "2019-03-12T00:00:00Z", + "dataUrl": "https://contoso.com/", + "id": "3881c67b-e497-481f-816f-5fff31063ca6", + "createdDateTime": "2019-03-12T17:12:19Z", + "lastActionDateTime": "2019-03-12T17:12:19Z", + "status": "Succeeded" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint data export task identified by the given ID.", + "operationId": "EndpointDataExport_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "endpointId", + "in": "path", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "id", + "in": "path", + "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" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/models": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of models for the authenticated subscription.", + "operationId": "Models_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "4f6e9e23-60f8-434e-847a-0aa19fcdaff9", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "0c327f4a-e0ee-497f-9fde-f1fefc5a2b6d", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "668c407a-53b6-4015-8529-9d6ee6267093", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + }, + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "36a6127a-18a8-4f19-bc04-a460478e08f6", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "f21dfd44-a6ba-4b5f-8fb4-9472e8871a40", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "Model_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "modelDefinition", + "in": "body", + "description": "The details of the new model.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechModelDefinition" + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "Model_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "2c91119e-c70e-4b90-9c56-31a2d98585ed", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "fd52edb6-ee38-4621-8c46-0937b96eba67", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "6531dba4-6edb-4c8f-9072-a8fb860216b2", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Deletes the model identified by the given ID.", + "operationId": "Model_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "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" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "Model_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "modelUpdate", + "in": "body", + "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" + } + }, + "examples": { + "application/json": { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "487041cc-6389-41bc-b2b0-e0ecb4155509", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "eea3202a-078c-469b-be59-a57cc4a3abb5", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "4c667715-b171-400c-9e5a-cf08c1166d78", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "SupportedLocalesForModels_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IReadOnlyDictionary" + }, + "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" + } + }, + "examples": { + "application/json": { + "Acoustic": [ + "en-US" + ], + "Language": [ + "en-US", + "de-DE" + ] + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/transcriptions": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of transcriptions for the authenticated subscription.", + "operationId": "Transcriptions_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "recordingsUrl": "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=24a9bd35-aec0-427e-a296-944b3ddd4c4b", + "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=e4a05216-7ab2-48d4-b655-9341613f2915" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "4a728a27-e2b2-42fd-bba6-1a67d79fa92a", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "455abd36-8fa3-4ecf-9f3f-c0c6e8e83361", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "18228bbe-cff8-4ac2-ae9e-44ee4563d3c5", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "0a83b2e5-08bf-428b-93af-89380a126e5c", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "4dc69357-b973-4cbb-ba37-3cd04d1208f6", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "statusMessage": "None.", + "id": "44dc2599-38ef-4475-896b-5687142934ce", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Creates a new transcription.", + "operationId": "Transcription_Create", + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "transcription", + "in": "body", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/TranscriptionDefinition" + } + } + ], + "responses": { + "202": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + }, + "503": { + "description": "In case the service is not available.", + "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" + } + }, + "examples": { + "application/json": { + "code": "ServiceUnavailable", + "message": "ServiceUnavailable" + } + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "Transcription_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "recordingsUrl": "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=24a9bd35-aec0-427e-a296-944b3ddd4c4b", + "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=e4a05216-7ab2-48d4-b655-9341613f2915" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "38c5cf91-031b-4a7c-a8ec-8b5337a0a441", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "21dbb2eb-7016-406c-8d1a-6e4f1ef0bdea", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "ea454223-d438-4e90-9e69-3426d2011892", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "6a1888ac-c47a-44ab-a8a2-c11cef61e84d", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "23fc4d95-8b33-4dd1-ac7d-2b40f1851545", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "statusMessage": "None.", + "id": "8391c139-b99b-48f6-991f-acf80439f5b5", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "Transcription_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The transcription task was successfully deleted.", + "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" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Updates the mutable details of the transcription identified by its ID.", + "operationId": "Transcription_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "transcriptionUpdate", + "in": "body", + "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" + } + }, + "examples": { + "application/json": { + "recordingsUrl": "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=24a9bd35-aec0-427e-a296-944b3ddd4c4b", + "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=e4a05216-7ab2-48d4-b655-9341613f2915" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "c4230d87-d2d6-437d-8e2a-9c2d60bc4b94", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "96a48648-4a97-458b-92ca-6d770e9e6cd3", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "c9f01e14-ad87-4956-9675-3f3b7995303c", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "3e80541c-91c4-4c84-bb3e-15ebda2f01a8", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "73f8a0a5-ef27-4e57-a9ad-c6e8c2f7ec77", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "statusMessage": "None.", + "id": "5a5eadd1-4708-4449-b519-925b8b877ab5", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/speechtotext/v2.0/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "SupportedLocalesForTranscriptions_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + "en-US", + "de-DE" + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/languagegeneration/v2.0/Endpoints": { + "get": { + "tags": [ + "Language Generation Endpoints:" + ], + "summary": "Gets all language generation endpoint of a subscription.", + "operationId": "LanguageGenerationEndpoints_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "endpointKind": "LanguageGeneration", + "models": [ + { + "modelKind": "LanguageGeneration", + "datasets": [ + { + "dataImportKind": "LanguageGeneration", + "id": "227e8a92-66a1-47f7-9d4e-019f071d1e20", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot", + "description": "CafeBot data" + } + ], + "id": "350ba846-4331-427a-a8f2-6d6953dd9875", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot model", + "description": "CafeBot en-us default", + "properties": { + "Domain": "CafeBot", + "Version": "default" + } + } + ], + "concurrentRecognitions": -1, + "contentLoggingEnabled": false, + "endpointUrls": { + "HttpRestLanguageGenerationInput": "https://westus.cts.speech.microsoft.com/v1/lg" + }, + "id": "7eaced0d-b83e-4cf6-83b0-540e598de57e", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language generation endpoint", + "description": "Example for language generation endpoint" + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Language Generation Endpoints:" + ], + "summary": "Creates a new language generation endpoint.", + "operationId": "LanguageGenerationEndpoint_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "endpointDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointDefinition" + } + } + ], + "responses": { + "204": { + "description": "No Content", + "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" + } + } + }, + "202": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/languagegeneration/v2.0/Endpoints/{id}": { + "get": { + "tags": [ + "Language Generation Endpoints:" + ], + "summary": "Gets the specified deployed language generation endpoint.", + "operationId": "LanguageGenerationEndpoint_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "endpointKind": "LanguageGeneration", + "models": [ + { + "modelKind": "LanguageGeneration", + "datasets": [ + { + "dataImportKind": "LanguageGeneration", + "id": "59dd7e58-e606-47ff-a921-77eca0c86b24", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot", + "description": "CafeBot data" + } + ], + "id": "e06d965b-61ce-4934-be41-dbfe3dab6727", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot model", + "description": "CafeBot en-us default", + "properties": { + "Domain": "CafeBot", + "Version": "default" + } + } + ], + "concurrentRecognitions": -1, + "contentLoggingEnabled": false, + "endpointUrls": { + "HttpRestLanguageGenerationInput": "https://westus.cts.speech.microsoft.com/v1/lg" + }, + "id": "67704bee-f926-43e6-81db-868176a6be53", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language generation endpoint", + "description": "Example for language generation endpoint" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Language Generation Endpoints:" + ], + "summary": "Deletes the language generation model endpoint with the given id.", + "operationId": "LanguageGenerationEndpoint_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the language generation model endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The language generation 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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Language Generation Endpoints:" + ], + "summary": "Updates the mutable details of the language generation endpoint identified by its id.", + "operationId": "LanguageGenerationEndpoint_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the language generation model endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "endpointUpdate", + "in": "body", + "description": "The object contains the updated fields of the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "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" + } + }, + "examples": { + "application/json": { + "endpointKind": "LanguageGeneration", + "models": [ + { + "modelKind": "LanguageGeneration", + "datasets": [ + { + "dataImportKind": "LanguageGeneration", + "id": "fa127567-9f68-4061-b6ee-e64d4da8a499", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot", + "description": "CafeBot data" + } + ], + "id": "77b77aa1-a52e-464d-bbfc-cc6406845bce", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot model", + "description": "CafeBot en-us default", + "properties": { + "Domain": "CafeBot", + "Version": "default" + } + } + ], + "concurrentRecognitions": -1, + "contentLoggingEnabled": false, + "endpointUrls": { + "HttpRestLanguageGenerationInput": "https://westus.cts.speech.microsoft.com/v1/lg" + }, + "id": "f3534470-5e4e-4802-82a4-4d9bdb4e2043", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language generation endpoint", + "description": "Example for language generation endpoint" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/languagegeneration/v2.0/Endpoints/locales": { + "get": { + "tags": [ + "Language Generation Endpoints:" + ], + "summary": "Gets a list of supported locales for language generation endpoint creation.", + "operationId": "SupportedLocalesForLanguageGenerationEndpoints_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + "en-US", + "de-DE" + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/languagegeneration/v2.0/Models": { + "get": { + "tags": [ + "Language Generation Models:" + ], + "summary": "Gets all language generation model of a subscription.", + "operationId": "LanguageGenerationModels_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "modelKind": "LanguageGeneration", + "datasets": [ + { + "dataImportKind": "LanguageGeneration", + "id": "6c3b4781-ab30-4778-a175-6338c86a0d07", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot", + "description": "CafeBot data" + } + ], + "id": "5b483cda-4dee-4898-8970-b1f2a7b550c5", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot model", + "description": "CafeBot en-us default", + "properties": { + "Domain": "CafeBot", + "Version": "default" + } + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Language Generation Models:" + ], + "summary": "Creates a new language generation model.", + "operationId": "LanguageGenerationModel_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "modelDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelDefinition" + } + } + ], + "responses": { + "204": { + "description": "No Content", + "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" + } + } + }, + "202": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/languagegeneration/v2.0/Models/{id}": { + "get": { + "tags": [ + "Language Generation Models:" + ], + "summary": "Gets the specified language generation model.", + "operationId": "LanguageGenerationModel_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "modelKind": "LanguageGeneration", + "datasets": [ + { + "dataImportKind": "LanguageGeneration", + "id": "e95a6423-ced6-44ce-8775-82cc4a900171", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot", + "description": "CafeBot data" + } + ], + "id": "42079b4a-7fda-4547-9ab2-3b6f5e79f3c9", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot model", + "description": "CafeBot en-us default", + "properties": { + "Domain": "CafeBot", + "Version": "default" + } + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Language Generation Models:" + ], + "summary": "Deletes the language generation model with the given id.", + "operationId": "LanguageGenerationModel_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the language generation model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The language generation 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" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Language Generation Models:" + ], + "summary": "Updates the mutable details of the language generation model identified by its id.", + "operationId": "LanguageGenerationModel_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The route parameter identifies the language generation model to change.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "modelUpdate", + "in": "body", + "description": "The object contains the updated fields of 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" + } + }, + "examples": { + "application/json": { + "modelKind": "LanguageGeneration", + "datasets": [ + { + "dataImportKind": "LanguageGeneration", + "id": "d27fdc5c-1194-4d08-9440-40ef7c9b8753", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot", + "description": "CafeBot data" + } + ], + "id": "16245480-2374-42eb-808e-5c0771a1405a", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "CafeBot model", + "description": "CafeBot en-us default", + "properties": { + "Domain": "CafeBot", + "Version": "default" + } + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/languagegeneration/v2.0/Models/locales": { + "get": { + "tags": [ + "Language Generation Models:" + ], + "summary": "Gets a list of supported locales for language generation model creation.", + "operationId": "SupportedLocalesForLanguageGenerationModels_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + "en-US", + "de-DE" + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/common/v2.0/healthstatus": { + "get": { + "tags": [ + "Service health:" + ], + "summary": "The action returns the health of the different components of the serivce.", + "operationId": "HealthStatus_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HealthStatusResponse" + }, + "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" + } + }, + "examples": { + "application/json": [ + { + "status": "Healthy", + "message": "", + "components": [ + { + "name": "Speech to Text", + "type": "STT", + "status": "Healthy", + "message": "" + } + ] + } + ] + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/datasets": { + "get": { + "tags": [ + "Voice datasets:" + ], + "summary": "Gets all voice datasets of a user.", + "operationId": "VoiceDatasets_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "dataImportKind": "CustomVoice", + "id": "aaebc4f7-350b-4a9b-8184-2a304a11afca", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/datasets/locales": { + "get": { + "tags": [ + "Voice datasets:" + ], + "summary": "Gets a list of supported locales for custom voice data imports.", + "operationId": "SupportedLocalesForVoiceDatasets_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + "en-US", + "de-DE" + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/datasets/upload": { + "post": { + "tags": [ + "Voice datasets:" + ], + "summary": "Uploads data and creates a new voice data object.", + "operationId": "VoiceDataset_Upload", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "multipart/form-data" + ], + "produces": [], + "parameters": [ + { + "name": "name", + "in": "formData", + "description": "The name of this data import (always add this string for any import).", + "type": "string" + }, + { + "name": "description", + "in": "formData", + "description": "Optional description of this data import.", + "type": "string" + }, + { + "name": "locale", + "in": "formData", + "description": "The locale of this data import (always add this string for any import).", + "type": "string" + }, + { + "name": "dataImportKind", + "in": "formData", + "description": "The kind of the data import (always add this string for any import).", + "type": "string", + "enum": [ + "None", + "Language", + "Acoustic", + "Pronunciation", + "CustomVoice", + "LanguageGeneration" + ] + }, + { + "name": "properties", + "in": "formData", + "description": "Optional properties of this data import (json serialized object with key/values, where all values must be strings)", + "type": "string" + }, + { + "name": "audiodata", + "in": "formData", + "description": "A zip file containing the audio data.", + "type": "file" + }, + { + "name": "transcriptions", + "in": "formData", + "description": "The transcriptions text file of the audio data.", + "type": "file" + } + ], + "responses": { + "201": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/datasets/{id}": { + "delete": { + "tags": [ + "Voice datasets:" + ], + "summary": "Deletes the voice dataset with the given id.", + "operationId": "VoiceDataset_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the voice dataset", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The voice 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" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Voice datasets:" + ], + "summary": "Updates the mutable details of the voice dataset identified by its ID.", + "operationId": "VoiceDataset_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the voice dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "datasetUpdate", + "in": "body", + "description": "The updated values for the voice 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" + } + }, + "examples": { + "application/json": { + "dataImportKind": "CustomVoice", + "id": "a1c1b093-ccad-49e5-b1e6-78ea7e275d24", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/endpoints": { + "get": { + "tags": [ + "Voice endpoints:" + ], + "summary": "Gets a list of voice endpoint details.", + "operationId": "VoiceDeployments_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "endpointKind": "CustomVoice", + "models": [ + { + "modelKind": "CustomVoice", + "datasets": [ + { + "dataImportKind": "CustomVoice", + "id": "b2d2c532-0c5c-463d-8122-bb82a57ba83c", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + ], + "id": "e530825d-b284-4e75-bbc0-a9a169f05730", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Voice model", + "description": "Example for voice model", + "properties": { + "Gender": "male" + } + } + ], + "concurrentRecognitions": 20, + "contentLoggingEnabled": false, + "endpointUrls": { + "Ssml": "https://cris.ai/synthesize/customvoice" + }, + "id": "73e4e3a3-ce7e-45d0-b5a9-1ca5f618ea9b", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice endpoint", + "description": "Example for voice endpoint" + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Voice endpoints:" + ], + "summary": "Creates a new voice endpoint object.", + "operationId": "VoiceDeployment_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "endpoint", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointDefinition" + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/endpoints/{id}": { + "get": { + "tags": [ + "Voice endpoints:" + ], + "summary": "Gets the details of a Custom Voice endpoint.", + "operationId": "VoiceDeployment_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "endpointKind": "CustomVoice", + "models": [ + { + "modelKind": "CustomVoice", + "datasets": [ + { + "dataImportKind": "CustomVoice", + "id": "0cdffb2a-5edb-4df0-8492-b3233b2e59cf", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + ], + "id": "2c2720da-e9aa-49a1-8756-0a656942bc83", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Voice model", + "description": "Example for voice model", + "properties": { + "Gender": "male" + } + } + ], + "concurrentRecognitions": 20, + "contentLoggingEnabled": false, + "endpointUrls": { + "Ssml": "https://cris.ai/synthesize/customvoice" + }, + "id": "f7181110-2934-4a7e-9563-2fed56146313", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice endpoint", + "description": "Example for voice endpoint" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Voice endpoints:" + ], + "summary": "Delete the specified voice endpoint.", + "operationId": "Deployment_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of voice endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model deployment 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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Voice endpoints:" + ], + "summary": "Updates the name and description of the endpoint identified by the given ID.", + "operationId": "VoiceEndpoint_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "endpointUpdate", + "in": "body", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "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" + } + }, + "examples": { + "application/json": { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "id": "9b4f9984-5ed3-4d10-8a5a-f9e777b800e8", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/ed9b62f0-aa8e-419c-ab55-d7ca83c2f6b3?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=2b5e9932-8c65-45e5-9f70-9854e1997034" + } + } + ], + "id": "1f8e979b-0c3c-408f-aef1-bc839cd26bc1", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "id": "df7f8c98-375f-4b62-a3a4-212bc9fe0cbf", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Base model", + "description": "Base model description", + "properties": {} + }, + "datasets": [ + { + "dataImportKind": "Language", + "id": "5dda180e-212a-4bf0-9ffa-05fb61c34a5c", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/e75c10b6-f6c3-4693-9fc7-a6baf32b599f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=c628a4fa-7501-4f8a-9f4e-3651fe696e39" + } + } + ], + "id": "ac8863ed-9f23-44f3-968a-bc487c54d82f", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://fedev.develop2.cris.ai/speech/recognition/interactive/cognitiveservices/v1?cid=77CB309E-5780-4DE4-877E-BE91B66FA548" + }, + "id": "07c07eff-197f-48be-8be0-089ef1826a7b", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/endpoints/locales": { + "get": { + "tags": [ + "Voice endpoints:" + ], + "summary": "Gets a list of supported locales for custom voice Endpoints.", + "operationId": "SupportedLocalesForVoiceEndpoints_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + "en-US", + "de-DE" + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/models": { + "get": { + "tags": [ + "Voice models:" + ], + "summary": "Gets a list of voice model details.", + "operationId": "VoiceModels_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + { + "modelKind": "CustomVoice", + "datasets": [ + { + "dataImportKind": "CustomVoice", + "id": "0efe4fc7-8c71-40be-a659-92fd7c5b7b04", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + ], + "id": "ec7f2f7c-714d-4b66-aaad-0aad2f2d0763", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Voice model", + "description": "Example for voice model", + "properties": { + "Gender": "male" + } + } + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "post": { + "tags": [ + "Voice models:" + ], + "summary": "Creates a new voice model object.", + "operationId": "VoiceModel_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "modelDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelDefinition" + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/models/{id}": { + "get": { + "tags": [ + "Voice models:" + ], + "summary": "Gets specified voice model details.", + "operationId": "VoiceModel_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "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 running 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" + } + }, + "examples": { + "application/json": { + "modelKind": "CustomVoice", + "datasets": [ + { + "dataImportKind": "CustomVoice", + "id": "14fd79e5-5b67-4e77-812e-776fac8dccbd", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + ], + "id": "68008a30-404f-4918-99f3-ba1a1197abe0", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Voice model", + "description": "Example for voice model", + "properties": { + "Gender": "male" + } + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Voice models:" + ], + "summary": "Deletes the voice model with the given id.", + "operationId": "VoiceModel_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the voice model", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The voice 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" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "patch": { + "tags": [ + "Voice models:" + ], + "summary": "Updates the metadata of the voice model identified by the given ID.", + "operationId": "VoiceModel_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the voice model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "modelUpdate", + "in": "body", + "description": "The updated values for the voice 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" + } + }, + "examples": { + "application/json": { + "modelKind": "CustomVoice", + "datasets": [ + { + "dataImportKind": "CustomVoice", + "id": "dae6f376-d75e-4e09-9a47-22d5d7e413ec", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + ], + "id": "c32b1bff-2af4-432c-a04a-81d81c5b0e98", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Voice model", + "description": "Example for voice model", + "properties": { + "Gender": "male" + } + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Conflict", + "message": "An operation on this resource already in progress." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/models/locales": { + "get": { + "tags": [ + "Voice models:" + ], + "summary": "Gets a list of supported locales for custom voice Models.", + "operationId": "SupportedLocalesForVoiceModels_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "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" + } + }, + "examples": { + "application/json": [ + "en-US", + "de-DE" + ] + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/tests/{id}": { + "get": { + "tags": [ + "Voice tests:" + ], + "summary": "Gets detail of the specified voice test.", + "operationId": "VoiceTest_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the voice test.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VoiceTest" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a running 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" + } + }, + "examples": { + "application/json": { + "audioUri": "https://cris.ai/wavetest/edtweryhrt546567645t54.wav", + "textUri": "https://cris.ai/wavetest/edtweryhrt546567645t54.txt", + "model": { + "modelKind": "CustomVoice", + "datasets": [ + { + "dataImportKind": "CustomVoice", + "id": "3799081d-006a-4caa-bf73-87de92b761f7", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Succeeded", + "locale": "en-US", + "name": "Voice dataset", + "description": "Example for voice dataset", + "properties": { + "Size": "50000", + "Gender": "male" + } + } + ], + "id": "56e65c2e-9e11-45f1-8517-8b1824a0307c", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running", + "locale": "en-US", + "name": "Voice model", + "description": "Example for voice model", + "properties": { + "Gender": "male" + } + }, + "voiceTestKind": "Text", + "id": "0cfa2885-0b60-4ccc-ba6e-33d7081c5a11", + "createdDateTime": "2019-03-20T14:46:19Z", + "lastActionDateTime": "2019-03-20T14:46:19Z", + "status": "Running" + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + }, + "delete": { + "tags": [ + "Voice tests:" + ], + "summary": "Deletes the specified voice test.", + "operationId": "VoiceTest_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the voice test.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The project 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.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "405": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "DeleteNotAllowed", + "message": "The task is still in use." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + }, + "/api/texttospeech/v2.0/tests": { + "post": { + "tags": [ + "Voice tests:" + ], + "summary": "Creates a new voice test.", + "operationId": "VoiceTest_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options" : { + "final-state-via" : "azure-async-operation" + }, + "consumes": [ + "application/json" + ], + "produces": [], + "parameters": [ + { + "name": "voiceTestDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VoiceTestDefinition" + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the operation as header.", + "headers": { + "Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "Operation-Location": { + "description": "The URI of the operation.", + "type": "string" + }, + "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" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully.", + "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" + } + }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + } + }, + "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" + } + }, + "examples": { + "application/json": {} + } + } + }, + "security": [ + { + "subscription_key": [], + "token": [] + } + ] + } + } + }, + "definitions": { + "IReadOnlyDictionary": { + "type": "object", + "properties": { + "none": { + "type": "array", + "items": { + "type": "string" + } + }, + "language": { + "description" :"language data information", + "type": "array", + "items": { + "type": "string" + } + }, + "acoustic": { + "description" :"acoustic data information", + "type": "array", + "items": { + "type": "string" + } + }, + "pronunciation": { + "description" :"pronunciation data information", + "type": "array", + "items": { + "type": "string" + } + }, + "customVoice": { + "description" :"voice data information", + "type": "array", + "items": { + "type": "string" + } + }, + "languageGeneration": { + "description" :"language information", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Test": { + "title": "Test", + "required": [ + "id", + "wordErrorRate", + "createdDateTime", + "lastActionDateTime", + "status", + "models", + "name" + ], + "type": "object", + "properties": { + "dataset": { + "$ref": "#/definitions/Dataset", + "description": "Information about the dataset used in the test" + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "wordErrorRate": { + "format": "double", + "description": "The word error rate of the tested model", + "type": "number" + }, + "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" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered", + "type": "string" + }, + "status": { + "description": "The status of the object", + "enum": [ + "Succeeded", + "Failed", + "NotStarted", + "Running" + ], + "type": "string" + }, + "models": { + "description": "Information about the models used for this accuracy test", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Dataset": { + "title": "Dataset", + "required": [ + "id", + "dataImportKind", + "name", + "createdDateTime", + "lastActionDateTime", + "status" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "dataImportKind": { + "description": "The kind of the dataset (e.g. acoustic data, language data ...)", + "enum": [ + "Acoustic", + "Language", + "Pronunciation", + "None", + "CustomVoice", + "LanguageGeneration" + ], + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered", + "type": "string" + }, + "status": { + "description": "The status of the object", + "enum": [ + "Succeeded", + "Failed", + "NotStarted", + "Running" + ], + "type": "string" + } + } + }, + "Model": { + "title": "Model", + "required": [ + "id", + "modelKind", + "name", + "createdDateTime", + "lastActionDateTime", + "status" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "baseModel": { + "$ref": "#/definitions/Model", + "description": "The base model used for adaptation" + }, + "datasets": { + "description": "Datasets used for adaptation", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + } + }, + "modelKind": { + "description": "The kind of this model (e.g. acoustic, language ...)", + "enum": [ + "AcousticAndLanguage", + "None", + "Acoustic", + "Language", + "CustomVoice", + "LanguageGeneration", + "Sentiment", + "LanguageIdentification" + ], + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered", + "type": "string" + }, + "status": { + "description": "The status of the object", + "enum": [ + "Succeeded", + "Failed", + "NotStarted", + "Running" + ], + "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/InnerError", + "description": "The stack trace of the error. The payload is service-defined.\r\nIf the error is not at the root level, the object contains a Code\r\nand an InnerError property" + }, + "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" + } + } + }, + "InnerError": { + "title": "InnerError", + "description": "An implementation of this interface represents a stage in a stack trace.\r\nIf the error level is the root, the {Microsoft.SpeechServices.Common.Client.IInnerError.Code} and the {Microsoft.SpeechServices.Common.Client.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/InnerError", + "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" + } + } + }, + "TestDefinition": { + "title": "TestDefinition", + "required": [ + "dataset", + "models", + "name" + ], + "type": "object", + "properties": { + "dataset": { + "$ref": "#/definitions/DatasetIdentity", + "description": "Information about the dataset used in the test" + }, + "models": { + "description": "Information about the models used for this accuracy test", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "example": { + "models": [ + { + "id": "a309500e-fe62-46ac-9dba-b36d7bdfc97d" + }, + { + "id": "5f16c7b3-a396-424b-9e47-bc53c7aef6fa" + } + ], + "dataset": { + "id": "c5e376c1-8dc1-4da9-92fb-9639d0ec33fd" + }, + "name": "Accuracy test", + "description": "This is an accuracy test", + "properties": {} + } + }, + "DatasetIdentity": { + "title": "DatasetIdentity", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + } + } + }, + "ModelIdentity": { + "title": "ModelIdentity", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + } + } + }, + "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" + } + }, + "example": { + "name": "Updated test name", + "description": "Updated test description" + } + }, + "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" + } + }, + "example": { + "name": "Updated dataset name", + "description": "Updated dataset description" + } + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "id", + "endpointKind", + "endpointUrls", + "createdDateTime", + "lastActionDateTime", + "status", + "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", + "example": "00000000-0000-0000-0000-000000000000" + }, + "endpointKind": { + "description": "The kind of this endpoint (e.g. custom speech, custom voice ...)", + "enum": [ + "None", + "SpeechRecognition", + "CustomVoice", + "LanguageGeneration", + "LanguageIdentification" + ], + "type": "string" + }, + "endpointUrls": { + "description": "The list of endpoint urls", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered", + "type": "string" + }, + "status": { + "description": "The status of the object", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string" + }, + "models": { + "description": "Information about the deployed models", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.\r\nSuppressing content logging will result in a higher cost for the deployment.\r\nFree subscriptions can only deploy true", + "type": "boolean" + }, + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + } + } + }, + "SpeechEndpointDefinition": { + "title": "SpeechEndpointDefinition", + "required": [ + "models", + "name" + ], + "type": "object", + "properties": { + "concurrentRecognitions": { + "format": "int32", + "description": "The number of concurrent recognitions the endpoint supports", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "models": { + "description": "Information about the deployed models", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.\r\nSuppressing content logging will result in a higher cost for the deployment.\r\nFree subscriptions can only deploy true", + "type": "boolean" + }, + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + } + }, + "example": { + "models": [ + { + "id": "6d25d8e9-1956-49b3-b8df-8ea955810a0a" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "locale": "en-US", + "name": "Speech endpoint definition", + "description": "This is a speech endpoint" + } + }, + "EndpointUpdate": { + "title": "EndpointUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object", + "type": "string" + }, + "description": { + "description": "The description of the object", + "type": "string" + } + }, + "example": { + "name": "Updated speech endpoint", + "description": "Example for an updated speech endpoint" + } + }, + "EndpointData": { + "title": "EndpointData", + "required": [ + "id", + "createdDateTime", + "lastActionDateTime", + "status", + "startDate", + "endDate" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "dataUrl": { + "description": "The resulting data Url for the model deployment", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered", + "type": "string" + }, + "status": { + "description": "The status of the object", + "enum": [ + "Succeeded", + "NotStarted", + "Running", + "Failed" + ], + "type": "string" + }, + "startDate": { + "format": "date-time", + "description": "The start date of the demplyment data export", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The end date of the demplyment data export", + "type": "string" + } + } + }, + "EndpointDataDefinition": { + "title": "EndpointDataDefinition", + "required": [ + "startDate", + "endDate" + ], + "type": "object", + "properties": { + "startDate": { + "format": "date-time", + "description": "The start date of the demplyment data export", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The end date of the demplyment data export", + "type": "string" + } + }, + "example": { + "startDate": "2019-02-10T00:00:00Z", + "endDate": "2019-03-12T00:00:00Z" + } + }, + "SpeechModelDefinition": { + "title": "SpeechModelDefinition", + "required": [ + "modelKind", + "name" + ], + "type": "object", + "properties": { + "text": { + "description": "The text used to adapt this language model", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/ModelIdentity", + "description": "The base model used for adaptation" + }, + "datasets": { + "description": "Datasets used for adaptation", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetIdentity" + } + }, + "modelKind": { + "description": "The kind of this model (e.g. acoustic, language ...)", + "enum": [ + "None", + "Acoustic", + "Language", + "AcousticAndLanguage", + "CustomVoice", + "LanguageGeneration", + "Sentiment", + "LanguageIdentification" + ], + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + } + }, + "example": { + "modelKind": "Language", + "baseModel": { + "id": "10d02e6c-d891-4187-a65c-ceeff8dc0b51" + }, + "datasets": [ + { + "id": "07d004f6-3ec9-4cc7-8f55-e5ca62759434" + } + ], + "locale": "en-US", + "name": "Language model", + "description": "This is a language model definition" + } + }, + "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" + } + }, + "example": { + "name": "Language generation model update", + "description": "This is a language generation model update" + } + }, + "WebHookUpdate": { + "title": "WebHookUpdate", + "required": [ + "configuration", + "active", + "name" + ], + "type": "object", + "properties": { + "configuration": { + "$ref": "#/definitions/WebHookConfigurationSecret", + "description": "The configuration of the web hook registration.\r\n \r\nIf the property secret is omitted or contains an empty string in a POST or PATCH request,\r\nno signature hash will be calculated.\r\n \r\nWhen retrieving web hook registration information from the service, the secret is always omitted" + }, + "active": { + "description": "A value indicating whether callbacks to the registered URL are made or not", + "type": "boolean" + }, + "name": { + "description": "The name of the object", + "type": "string" + }, + "description": { + "description": "The description of the object", + "type": "string" + } + } + }, + "WebHookConfigurationSecret": { + "title": "WebHookConfigurationSecret", + "type": "object", + "properties": { + "secret": { + "description": "A secret that will be used to create a SHA1 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" + } + } + }, + "Transcription": { + "title": "Transcription", + "required": [ + "recordingsUrl", + "id", + "models", + "createdDateTime", + "lastActionDateTime", + "status", + "name" + ], + "type": "object", + "properties": { + "recordingsUrl": { + "type": "string" + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "models": { + "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" + } + }, + "statusMessage": { + "description": "The failure reason for the transcription", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered", + "type": "string" + }, + "status": { + "description": "The status of the object", + "enum": [ + "Succeeded", + "NotStarted", + "Running", + "Failed" + ], + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TranscriptionDefinition": { + "title": "TranscriptionDefinition", + "required": [ + "recordingsUrl", + "name" + ], + "type": "object", + "properties": { + "recordingsUrl": { + "type": "string" + }, + "models": { + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "example": { + "recordingsUrl": "https://contoso.com/mystoragelocation", + "models": [], + "locale": "en-US", + "name": "Transcription using locale en-US", + "description": "An optional description of the transcription.", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic" + } + } + }, + "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" + } + }, + "example": { + "name": "Updated transcription name", + "description": "Updated transcription description" + } + }, + "EndpointDefinition": { + "title": "EndpointDefinition", + "required": [ + "models", + "name" + ], + "type": "object", + "properties": { + "concurrentRecognitions": { + "format": "int32", + "description": "The number of concurrent recognitions the endpoint supports", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "models": { + "description": "Information about the deployed models", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.\r\nSuppressing content logging will result in a higher cost for the deployment.\r\nFree subscriptions can only deploy true", + "type": "boolean" + }, + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + } + }, + "example": { + "models": [ + { + "id": "8293ae89-9455-4203-b962-b93a535aa6ee" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "locale": "en-US", + "name": "Voice endpoint definition", + "description": "Example for voice endpoint definition" + } + }, + "ModelDefinition": { + "title": "ModelDefinition", + "required": [ + "modelKind", + "name" + ], + "type": "object", + "properties": { + "text": { + "description": "The text used to adapt this language model", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/ModelIdentity", + "description": "The base model used for adaptation" + }, + "datasets": { + "description": "Datasets used for adaptation", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetIdentity" + } + }, + "modelKind": { + "description": "The kind of this model (e.g. acoustic, language ...)", + "enum": [ + "Acoustic", + "AcousticAndLanguage", + "Language", + "None", + "CustomVoice", + "LanguageGeneration", + "Sentiment", + "LanguageIdentification" + ], + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + } + }, + "example": { + "modelKind": "CustomVoice", + "datasets": [ + { + "id": "b636ec91-9ddc-4810-83fe-eef72b8f8481" + } + ], + "locale": "en-US", + "name": "Voice model definition", + "description": "Example for voice model definition", + "properties": { + "Gender": "male" + } + } + }, + "HealthStatusResponse": { + "title": "HealthStatusResponse", + "type": "object", + "properties": { + "status": { + "enum": [ + "Healthy", + "Sick", + "Error" + ], + "type": "string" + }, + "message": { + "type": "string" + }, + "components": { + "type": "array", + "items": { + "$ref": "#/definitions/Component" + } + } + } + }, + "Component": { + "title": "Component", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "status": { + "enum": [ + "Healthy", + "Sick", + "Error" + ], + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "DatasetDefinition": { + "title": "DatasetDefinition", + "required": [ + "dataImportKind", + "name" + ], + "type": "object", + "properties": { + "dataImportKind": { + "description": "The kind of the dataset (e.g. acoustic data, language data ...)", + "enum": [ + "None", + "Language", + "Acoustic", + "Pronunciation", + "CustomVoice", + "LanguageGeneration" + ], + "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", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data", + "type": "string" + } + } + }, + "VoiceTest": { + "title": "VoiceTest", + "required": [ + "id", + "textUri", + "createdDateTime", + "lastActionDateTime", + "status", + "model", + "voiceTestKind" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "audioUri": { + "description": "The audio URI of the voice test", + "type": "string" + }, + "textUri": { + "description": "The text URI of the voice test", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered", + "type": "string" + }, + "status": { + "description": "The status of the object", + "enum": [ + "Succeeded", + "NotStarted", + "Running", + "Failed" + ], + "type": "string" + }, + "model": { + "$ref": "#/definitions/Model", + "description": "Information about the models used in the voice test" + }, + "voiceTestKind": { + "description": "The kind of this test (e.g. Text, SSML)", + "enum": [ + "None", + "Text", + "SSML" + ], + "type": "string" + } + } + }, + "VoiceTestDefinition": { + "title": "VoiceTestDefinition", + "required": [ + "text", + "model", + "voiceTestKind" + ], + "type": "object", + "properties": { + "text": { + "description": "Information about the text used in the voice test", + "type": "string" + }, + "model": { + "$ref": "#/definitions/ModelIdentity", + "description": "Information about the models used in the voice test" + }, + "voiceTestKind": { + "description": "The kind of this test (e.g. Text, SSML)", + "enum": [ + "None", + "Text", + "SSML" + ], + "type": "string" + } + }, + "example": { + "model": { + "id": "7d144389-6c8e-40bf-8ad4-d3e66cf6ac14" + }, + "text": "Hello world", + "voiceTestKind": "Text" + } + } + }, + "securityDefinitions": { + "subscription_key": { + "type": "apiKey", + "description": "Provide your cognitive services subscription key here.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "token": { + "type": "apiKey", + "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", + "name": "Authorization", + "in": "header" + } + } +} \ No newline at end of file