From 961e99d94f8cf6c7e5e783807c53f7dc0b60dc85 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 17 Feb 2021 16:43:37 +0100 Subject: [PATCH 01/34] Add custom speech apis --- .../stable/v2.0/speechtotext.json | 5763 ++++++++++++ .../stable/v3.0/speechtotext.json | 8077 +++++++++++++++++ 2 files changed, 13840 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json new file mode 100644 index 000000000000..b2db4c77e20a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -0,0 +1,5763 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API v2.0", + "description": "Speech Services API v2.0.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://docs.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "v2.0" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/speechtotext/v2.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/accuracytests": { + "get": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Gets the list of accuracy tests for the authenticated subscription.", + "operationId": "GetAccuracyTests", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Test" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "post": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Creates a new accuracy test.", + "operationId": "CreateAccuracyTest", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "testDefinition", + "description": "The details of the new accuracy test.", + "required": true, + "schema": { + "title": "TestDefinition", + "allOf": [ + { + "$ref": "#/definitions/TestDefinition" + } + ] + } + } + ], + "responses": { + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/accuracytests/{id}": { + "get": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Gets the accuracy test identified by the given ID.", + "operationId": "GetAccuracyTest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the accuracy test.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Test" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Updates the mutable details of the test identified by its id.", + "operationId": "UpdateAccuracyTest", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the accuracy test.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "testUpdate", + "description": "The object containing the updated fields of the test.", + "required": true, + "schema": { + "title": "TestUpdate", + "allOf": [ + { + "$ref": "#/definitions/TestUpdate" + } + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Test" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech accuracy tests:" + ], + "summary": "Deletes the accuracy test identified by the given ID.", + "operationId": "DeleteAccuracyTest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the accuracy test.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The test was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for data imports.", + "operationId": "GetSupportedLocalesForDatasets", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "IReadOnlyDictionary`2", + "type": "object", + "properties": { + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Pronunciation": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of datasets for the authenticated subscription.", + "operationId": "GetDatasets", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "GetDataset", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Updates the mutable details of the dataset identified by its ID.", + "operationId": "UpdateDataset", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "datasetUpdate", + "description": "The updated values for the dataset.", + "required": true, + "schema": { + "title": "DatasetUpdate", + "allOf": [ + { + "$ref": "#/definitions/DatasetUpdate" + } + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Deletes the specified dataset.", + "operationId": "DeleteDataset", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The dataset was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets/upload": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads data and creates a new dataset.", + "operationId": "UploadDataset", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "formData", + "name": "name", + "description": "The name of this data import (always add this string for any import).", + "type": "string" + }, + { + "in": "formData", + "name": "description", + "description": "Optional description of this data import.", + "type": "string" + }, + { + "in": "formData", + "name": "locale", + "description": "The locale of this data import (always add this string for any import).", + "type": "string" + }, + { + "in": "formData", + "name": "dataImportKind", + "description": "The kind of the data import (always add this string for any import). Possible values are \"Language\", \"Acoustic\", \"Pronunciation\".", + "type": "string" + }, + { + "in": "formData", + "name": "properties", + "description": "Optional properties of this data import (json serialized object with key/values, where all values must be strings)", + "type": "string" + }, + { + "in": "formData", + "name": "audiodata", + "description": "A zip file containing the audio data (this and the audio archive file for acoustic data imports).", + "type": "file" + }, + { + "in": "formData", + "name": "transcriptions", + "description": "A text file containing the transcriptions for the audio data (this and the transcriptions file for acoustic data imports).", + "type": "file" + }, + { + "in": "formData", + "name": "languagedata", + "description": "A text file containing the language or pronunciation data (only this file for language data imports).", + "type": "file" + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "In case the media type of a file part is not supported.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "GetSupportedLocalesForEndpoints", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/endpoints": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoints for the authenticated subscription.", + "operationId": "GetEndpoints", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "CreateEndpoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "endpointDefinition", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "title": "SpeechEndpointDefinition", + "allOf": [ + { + "$ref": "#/definitions/SpeechEndpointDefinition" + } + ] + } + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/endpoints/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the endpoint identified by the given ID.", + "operationId": "GetEndpoint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint identified by the given ID.", + "operationId": "DeleteEndpoint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model endpoint was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Updates the metadata of the endpoint identified by the given ID.", + "operationId": "UpdateEndpoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "endpointUpdate", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "title": "EndpointMetadataUpdate", + "allOf": [ + { + "$ref": "#/definitions/EndpointMetadataUpdate" + } + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/endpoints/{endpointId}/data": { + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the transcriptions and captured audio files associated with the endpoint identified by the given ID.", + "description": "Deletion will happen in the background and can take up to a day.", + "operationId": "DeleteEndpointData", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The endpoint data export tasks were successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoint data export tasks for the authenticated user.", + "operationId": "GetEndpointDataExports", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointData" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Create a new endpoint data export task.", + "operationId": "CreateEndpointDataExport", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "endpointDataDefinition", + "description": "The details of the new endpoint data export.", + "required": true, + "schema": { + "title": "EndpointDataDefinition", + "allOf": [ + { + "$ref": "#/definitions/EndpointDataDefinition" + } + ] + } + } + ], + "responses": { + "202": { + "description": "The response contains the id of the endpoint data export task.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/endpoints/{endpointId}/data/{id}": { + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint data export task identified by the given ID.", + "operationId": "DeleteEndpointDataExport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint data export.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The endpoint data export task was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the specified endpoint data export task for the authenticated user.", + "operationId": "GetEndpointDataExport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "endpointId", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "id", + "description": "The identifier of the data export.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointData" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "GetSupportedLocalesForModels", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "IReadOnlyDictionary`2", + "type": "object", + "properties": { + "None": { + "type": "array", + "items": { + "type": "string" + } + }, + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "AcousticAndLanguage": { + "type": "array", + "items": { + "type": "string" + } + }, + "Sentiment": { + "type": "array", + "items": { + "type": "string" + } + }, + "Diarization": { + "type": "array", + "items": { + "type": "string" + } + }, + "PronunciationScore": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of models for the authenticated subscription.", + "operationId": "GetModels", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "CreateModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "modelDefinition", + "description": "The details of the new model.", + "required": true, + "schema": { + "title": "SpeechModelDefinition", + "allOf": [ + { + "$ref": "#/definitions/SpeechModelDefinition" + } + ] + } + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "GetModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "UpdateModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "modelUpdate", + "description": "The updated values for the model.", + "required": true, + "schema": { + "title": "ModelUpdate", + "allOf": [ + { + "$ref": "#/definitions/ModelUpdate" + } + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Deletes the model identified by the given ID.", + "operationId": "DeleteModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model was successfully deleted.", + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "GetSupportedLocalesForTranscriptions", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/transcriptions": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of transcriptions for the authenticated subscription.", + "operationId": "GetTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of transcriptions that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "take", + "description": "Number of transcriptions that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Transcription" + } + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Creates a new transcription.", + "operationId": "CreateTranscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "transcription", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "title": "TranscriptionDefinition", + "allOf": [ + { + "$ref": "#/definitions/TranscriptionDefinition" + } + ] + } + } + ], + "responses": { + "202": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + }, + "Operation-Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "GetTranscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + }, + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Updates the mutable details of the transcription identified by its ID.", + "operationId": "UpdateTranscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "transcriptionUpdate", + "description": "The updated values for the transcription.", + "required": true, + "schema": { + "title": "TranscriptionUpdate", + "allOf": [ + { + "$ref": "#/definitions/TranscriptionUpdate" + } + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "DeleteTranscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The transcription task was successfully deleted.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + } + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/ErrorContent" + }, + "headers": { + "X-RateLimit-Limit": { + "description": "The limit of requests for the resource.", + "type": "integer" + }, + "X-RateLimit-Remaining": { + "description": "The remaining number of requests until the rate limit is reached.", + "type": "integer" + }, + "X-RateLimit-Reset": { + "description": "The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + } + }, + "definitions": { + "Dataset": { + "title": "Dataset", + "required": [ + "dataImportKind", + "id", + "locale", + "name" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "dataImportKind": { + "description": "The kind of the dataset (e.g. acoustic data, language data ...)", + "enum": [ + "None", + "Language", + "Acoustic", + "Pronunciation" + ], + "type": "string" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "DatasetIdentity": { + "title": "DatasetIdentity", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + } + } + }, + "DatasetUpdate": { + "title": "DatasetUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "endpointKind", + "id", + "locale", + "models", + "name" + ], + "type": "object", + "properties": { + "concurrentRecognitions": { + "format": "int32", + "description": "The number of concurrent recognitions the endpoint supports.", + "type": "integer" + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "endpointUrls": { + "description": "The list of endpoint urls.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "endpointKind": { + "description": "The kind of this endpoint (e.g. custom speech).", + "enum": [ + "SpeechRecognition", + "PronunciationScore" + ], + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "models": { + "description": "Information about the deployed models.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EndpointData": { + "title": "EndpointData", + "required": [ + "endDate", + "id", + "startDate" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "dataUrl": { + "description": "The resulting data Url for the model deployment.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "startDate": { + "format": "date-time", + "description": "The start date of the demplyment data export.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The end date of the demplyment data export.", + "type": "string" + } + } + }, + "EndpointDataDefinition": { + "title": "EndpointDataDefinition", + "required": [ + "endDate", + "startDate" + ], + "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" + } + } + }, + "EndpointMetadataUpdate": { + "title": "EndpointMetadataUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "ErrorContent": { + "title": "ErrorContent", + "description": "The interface represents the content of an error response defined in the OneAPI v2.1 documentation.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "details": { + "description": "An array of details representing distinct related errors that occured during the request.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "title": "InnerErrorV2", + "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.", + "allOf": [ + { + "$ref": "#/definitions/InnerErrorV2" + } + ] + }, + "code": { + "description": "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error. It is intended as\r\nan aid to developers and is not suitable for exposure to end users.", + "type": "string" + }, + "target": { + "description": "The target of the particular error (e.g., the name of the property in error).", + "type": "string" + } + } + }, + "ErrorDetail": { + "title": "ErrorDetail", + "description": "An array of implementations of this interface can be used as details for an error.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error. It is intended as\r\nan aid to developers and is not suitable for exposure to end users.", + "type": "string" + }, + "target": { + "description": "The target of the particular error (e.g., the name of the property in error).", + "type": "string" + } + } + }, + "InnerErrorV2": { + "title": "InnerErrorV2", + "description": "An implementation of this interface represents a stage in a stack trace.\r\nIf the error levvel is the root, the Microsoft.SpeechServices.Http.Dto.IInnerError.Code and the Microsoft.SpeechServices.Http.Dto.IInnerError.InnerError\r\nproperty may be omitted.", + "type": "object", + "properties": { + "code": { + "description": "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response.", + "type": "string" + }, + "innererror": { + "title": "InnerErrorV2", + "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.", + "allOf": [ + { + "$ref": "#/definitions/InnerErrorV2" + } + ] + } + } + }, + "Model": { + "title": "Model", + "required": [ + "id", + "locale", + "modelKind", + "name" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "modelKind": { + "description": "The kind of this model (e.g. acoustic, language ...)", + "enum": [ + "None", + "Acoustic", + "Language", + "AcousticAndLanguage", + "Sentiment", + "Diarization", + "PronunciationScore" + ], + "type": "string" + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "title": "Model", + "description": "The base model used for adaptation.", + "allOf": [ + { + "$ref": "#/definitions/Model" + } + ] + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "ModelIdentity": { + "title": "ModelIdentity", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "SpeechEndpointDefinition": { + "title": "SpeechEndpointDefinition", + "required": [ + "locale", + "models", + "name" + ], + "type": "object", + "properties": { + "concurrentRecognitions": { + "format": "int32", + "description": "The number of concurrent recognitions the endpoint supports.", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "models": { + "description": "Information about the deployed models.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "description": "The name of the object.", + "type": "string" + } + } + }, + "SpeechModelDefinition": { + "title": "SpeechModelDefinition", + "required": [ + "locale", + "modelKind", + "name" + ], + "type": "object", + "properties": { + "modelKind": { + "description": "The kind of this model (e.g. acoustic, language ...)", + "enum": [ + "None", + "Acoustic", + "Language", + "AcousticAndLanguage", + "Sentiment", + "Diarization", + "PronunciationScore" + ], + "type": "string" + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "title": "ModelIdentity", + "description": "The base model used for adaptation.", + "allOf": [ + { + "$ref": "#/definitions/ModelIdentity" + } + ] + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetIdentity" + } + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "description": "The name of the object.", + "type": "string" + } + } + }, + "Test": { + "title": "Test", + "required": [ + "id", + "models", + "name" + ], + "type": "object", + "properties": { + "resultsUrl": { + "description": "The URL that can be used to download the test results.\r\nEach line in the file represents a tab separated list of filename, reference transcription and decoder output.\r\n \r\nThe URL will only be valid, if the test completed successfully.", + "type": "string", + "readOnly": true + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "wordErrorRate": { + "format": "double", + "description": "The word error rate of the tested model.", + "type": "number", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "models": { + "description": "Information about the models used for this accuracy test.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "dataset": { + "title": "Dataset", + "description": "Information about the dataset used in the test.", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ] + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TestDefinition": { + "title": "TestDefinition", + "required": [ + "models", + "name" + ], + "type": "object", + "properties": { + "models": { + "description": "Information about the models used for this accuracy test.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "dataset": { + "title": "DatasetIdentity", + "description": "Information about the dataset used in the test.", + "allOf": [ + { + "$ref": "#/definitions/DatasetIdentity" + } + ] + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TestUpdate": { + "title": "TestUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + }, + "Transcription": { + "title": "Transcription", + "required": [ + "id", + "locale", + "name", + "recordingsUrl" + ], + "type": "object", + "properties": { + "recordingsUrl": { + "type": "string" + }, + "reportFileUrl": { + "type": "string", + "readOnly": true + }, + "id": { + "format": "uuid", + "description": "The identifier of this entity.", + "type": "string" + }, + "models": { + "description": "The models used in this transcription.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "resultsUrls": { + "description": "The results Urls for the transcription.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "statusMessage": { + "description": "The failure reason for the transcription.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TranscriptionDefinition": { + "title": "TranscriptionDefinition", + "required": [ + "locale", + "name", + "recordingsUrl" + ], + "type": "object", + "properties": { + "recordingsUrl": { + "type": "string" + }, + "models": { + "description": "The models used in this transcription.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelIdentity" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "properties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "subscription_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services subscription key here." + }, + "token": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json new file mode 100644 index 000000000000..b5593eec6819 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -0,0 +1,8077 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API v3.0", + "description": "Speech Services API v3.0.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://docs.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "v3.0" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/speechtotext/v3.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for data imports.", + "operationId": "GetSupportedLocalesForDatasets", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "DatasetLocales", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": false + } + } + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of datasets for the authenticated subscription.", + "operationId": "GetDatasets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads and creates a new dataset by getting the data from a specified URL.", + "operationId": "CreateDataset", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "dataset", + "description": "Definition for the new dataset.", + "required": true, + "schema": { + "title": "Dataset", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "GetDataset", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Updates the mutable details of the dataset identified by its ID.", + "operationId": "UpdateDataset", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "datasetUpdate", + "description": "The updated values for the dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Deletes the specified dataset.", + "operationId": "DeleteDataset", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The dataset was successfully deleted or did not exist." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets/upload": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads data and creates a new dataset.", + "operationId": "UploadDatasetFromForm", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "formData", + "name": "project", + "description": "The optional string representation of the url of a project. If set, the dataset will be associated with that project.", + "type": "string" + }, + { + "in": "formData", + "name": "displayName", + "description": "The name of this data import (required).", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "description", + "description": "Optional description of this data import.", + "type": "string" + }, + { + "in": "formData", + "name": "locale", + "description": "The locale of this data import (required).", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "kind", + "description": "The kind of the data import (required). Possible values are \"Language\", \"Acoustic\", \"Pronunciation\", \"AudioFiles\".", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "customProperties", + "description": "The optional custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.", + "type": "string" + }, + { + "in": "formData", + "name": "data", + "description": "For acoustic data imports, a zip file containing the audio data and a text file containing the transcriptions for the audio data. For language data imports, a text file containing the language or pronunciation data. Required in both cases.", + "type": "file" + }, + { + "in": "formData", + "name": "email", + "description": "An optional string containing the email address to send email notifications to in case the operation completes. The value will be removed after successfully sending the email.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "415": { + "description": "In case the media type of a file part is not supported.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "deprecated": true, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/datasets/{id}/files": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the files of the dataset identified by the given ID.", + "operationId": "GetDatasetFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Number of files that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/datasets/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets one specific file (identified with fileId) from a dataset (identified with id).", + "operationId": "GetDatasetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "GetSupportedLocalesForEndpoints", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/endpoints": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoints for the authenticated subscription.", + "operationId": "GetEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of endpoints that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of endpoints that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "CreateEndpoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "endpoint", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "title": "Endpoint", + "allOf": [ + { + "$ref": "#/definitions/Endpoint" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/endpoints/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the endpoint identified by the given ID.", + "operationId": "GetEndpoint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint identified by the given ID.", + "operationId": "DeleteEndpoint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model endpoint was successfully deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Updates the metadata of the endpoint identified by the given ID.", + "operationId": "UpdateEndpoint", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "endpointUpdate", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/endpoints/{id}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored for a given endpoint.", + "operationId": "GetEndpointLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included (between 1 and 5000).", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.", + "description": "The deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "DeleteEndpointLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/endpoints/{id}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for a given endpoint.", + "operationId": "GetEndpointLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored for a given endpoint.", + "operationId": "DeleteEndpointLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/endpoints/base/{locale}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.", + "operationId": "GetBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included (between 1 and 5000).", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored when using the default base model of a given language. It deletes all logs before (and including) a specific day.", + "description": "Deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "DeleteBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/endpoints/base/{locale}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for the default base model in a given language.", + "operationId": "GetBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored when using the default base model of a given language.", + "operationId": "DeleteBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/evaluations/locales": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets a list of supported locales for evaluations.", + "operationId": "GetSupportedLocalesForEvaluations", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/evaluations": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the list of evaluations for the authenticated subscription.", + "operationId": "GetEvaluations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of evaluations that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of evaluations that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Creates a new evaluation.", + "operationId": "CreateEvaluation", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "evaluation", + "description": "The details of the new evaluation.", + "required": true, + "schema": { + "title": "Evaluation", + "allOf": [ + { + "$ref": "#/definitions/Evaluation" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/evaluations/{id}/files": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the files of the evaluation identified by the given ID.", + "operationId": "GetEvaluationFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Number of files that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/evaluations/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets one specific file (identified with fileId) from an evaluation (identified with id).", + "operationId": "GetEvaluationFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/evaluations/{id}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the evaluation identified by the given ID.", + "operationId": "GetEvaluation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Updates the mutable details of the evaluation identified by its id.", + "operationId": "UpdateEvaluation", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "evaluationUpdate", + "description": "The object containing the updated fields of the evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Deletes the evaluation identified by the given ID.", + "operationId": "DeleteEvaluation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The evaluation was successfully deleted or did not exist." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "GetSupportedLocalesForModels", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of custom models for the authenticated subscription.", + "operationId": "GetModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of models that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of models that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "CreateModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "model", + "description": "The details of the new model.", + "required": true, + "schema": { + "title": "Model", + "allOf": [ + { + "$ref": "#/definitions/Model" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models/base": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of base models for the authenticated subscription.", + "operationId": "GetBaseModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of base models that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of base models that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedModels" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "GetModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "UpdateModel", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "modelUpdate", + "description": "The updated values for the model.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Deletes the model identified by the given ID.", + "operationId": "DeleteModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model was successfully deleted or did not exist." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models/base/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the base model identified by the given ID.", + "operationId": "GetBaseModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the base model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models/{id}/copyto": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Copies a model from one subscription to another.", + "description": "This method can be used to copy a model from one location to another. If the target subscription\r\nkey belongs to a subscription created for another location, the model will be copied to that location.\r\nOnly adapted models are allowed to copy to another subscription.", + "operationId": "CopyModelToSubscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model that will be copied.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "modelCopy", + "description": "The body contains the subscription key of the target subscription.", + "required": true, + "schema": { + "title": "ModelCopy", + "allOf": [ + { + "$ref": "#/definitions/ModelCopy" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Model" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this model which can be used in an on-premise container.", + "operationId": "GetModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/models/base/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this base model which can be used in an on-premise container.", + "operationId": "GetBaseModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/projects/locales": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of supported locales.", + "operationId": "GetSupportedProjectLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/projects": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of projects for the authenticated subscription.", + "operationId": "GetProjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of projects that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of projects that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedProjects" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Creates a new project.", + "operationId": "CreateProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "project", + "description": "The details of the project.", + "required": true, + "schema": { + "title": "Project", + "allOf": [ + { + "$ref": "#/definitions/Project" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/projects/{id}": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the project identified by the given ID.", + "operationId": "GetProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Updates the project identified by the given ID.", + "operationId": "UpdateProject", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "projectUpdate", + "description": "The updated values for the project.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Deletes the project identified by the given ID.", + "operationId": "DeleteProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The project was successfully deleted or did not exist." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/projects/{id}/evaluations": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of evaluations for specified project.", + "operationId": "GetEvaluationsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of evaluations that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of evaluations that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/projects/{id}/datasets": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of datasets for specified project.", + "operationId": "GetDatasetsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/projects/{id}/endpoints": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of endpoints for specified project.", + "operationId": "GetEndpointsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of endpoints that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of endpoints that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/projects/{id}/models": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of models for specified project.", + "operationId": "GetModelsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of models that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of models that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/projects/{id}/transcriptions": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of transcriptions for specified project.", + "operationId": "GetTranscriptionsForProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "skip", + "description": "Number of transcriptions that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of transcriptions that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "GetSupportedLocalesForTranscriptions", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/transcriptions": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of transcriptions for the authenticated subscription.", + "operationId": "GetTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of transcriptions that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of transcriptions that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Creates a new transcription.", + "operationId": "CreateTranscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "transcription", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "title": "Transcription", + "allOf": [ + { + "$ref": "#/definitions/Transcription" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "GetTranscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Updates the mutable details of the transcription identified by its ID.", + "operationId": "UpdateTranscription", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "transcriptionUpdate", + "description": "The updated values for the transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/TranscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "DeleteTranscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The transcription was successfully deleted or did not exist." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/transcriptions/{id}/files": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the files of the transcription identified by the given ID.", + "operationId": "GetTranscriptionFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Number of files that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of files that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + } + }, + "/transcriptions/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets one specific file (identified with fileId) from a transcription (identified with id).", + "operationId": "GetTranscriptionFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/webhooks": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the list of web hooks for the authenticated subscription.", + "operationId": "GetHooks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skip", + "description": "Number of hooks that will be skipped.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "top", + "description": "Number of hooks that will be included after skipping.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebHooks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + } + }, + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Creates a new web hook.", + "description": "If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with\r\nthe secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nWhen calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event\r\ntypes. There will be one request per registered event type.\r\n \r\nAfter successfully registering the web hook, it will not be usable until a challenge/response is completed. To do this, a request with the event type\r\nchallenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken\r\nquery parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.", + "operationId": "CreateHook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "webHook", + "description": "The details of the new web hook.", + "required": true, + "schema": { + "title": "WebHook", + "allOf": [ + { + "$ref": "#/definitions/WebHook" + } + ] + } + } + ], + "responses": { + "201": { + "description": "The response contains the location of the entity as header.", + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/webhooks/{id}": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the web hook identified by the given ID.", + "operationId": "GetHook", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "patch": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Updates the web hook identified by the given ID.", + "description": "If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature\r\nheaders. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash\r\nwill be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nIf the URL changes, the web hook will stop receiving events until a\r\nchallenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken.\r\nRespond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response\r\nis successfully completed, the web hook will begin receiving events.", + "operationId": "UpdateHook", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "webHookUpdate", + "description": "The updated values for the web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHookUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "409": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + }, + "delete": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Deletes the web hook identified by the given ID.", + "operationId": "DeleteHook", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The web hook was successfully deleted." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + }, + "/webhooks/{id}/ping": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a ping event to the registered URL.", + "description": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.\r\nThe Swagger Schema ID of the model is WebHookV3.\r\n \r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with\r\na secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "PingHook", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "Started trying to send a ping request to the web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/webhooks/{id}/test": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a request for each registered event type to the registered URL.", + "description": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,\r\nthe POST will respond with 204. If a test request can be made, it will respond with 200.\r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.\r\nIf the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "TestHook", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "A test request with the last entity is sent to the registered web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer" + }, + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "204": { + "description": "No entity could be found for any event type, so no test request is sent to the registered web hook." + }, + "400": { + "description": "In case the operation cannot be performed successfully with the specified values.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "404": { + "description": "In case the specified entity doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/healthstatus": { + "get": { + "tags": [ + "Service Health:" + ], + "summary": "Returns the overall health of the service and optionally of the different subcomponents.", + "operationId": "GetHealthStatus", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HealthStatus" + } + }, + "401": { + "description": "In case the user isn't authorized.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "In case authorized user isn't known or doesn't have the required permissions.", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "In case the rate limit has been exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "subscription_key": [ ], + "token": [ ] + } + ] + } + } + }, + "definitions": { + "Component": { + "title": "Component", + "type": "object", + "properties": { + "message": { + "description": "Additional messages about the current service health.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the component.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The health status of this component.", + "enum": [ + "Healthy", + "Degraded", + "Unhealthy" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": false + } + }, + "type": { + "description": "The type of this component.", + "type": "string", + "readOnly": true + } + } + }, + "Dataset": { + "title": "Dataset", + "required": [ + "displayName", + "kind", + "locale" + ], + "type": "object", + "properties": { + "links": { + "title": "Links", + "description": "The links for additional actions or content related to this dataset.", + "allOf": [ + { + "$ref": "#/definitions/Links" + } + ], + "readOnly": true + }, + "properties": { + "title": "DatasetProperties", + "description": "Additional configuration options when creating a new dataset and additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/DatasetProperties" + } + ] + }, + "kind": { + "description": "The kind of the dataset.", + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": false + } + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "project": { + "title": "EntityReference", + "description": "The project, the dataset is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "contentUrl": { + "description": "The URL of the data for the dataset.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "DatasetProperties": { + "title": "DatasetProperties", + "type": "object", + "properties": { + "acceptedLineCount": { + "format": "int32", + "description": "The number of lines accepted for this data set.", + "type": "integer", + "readOnly": true + }, + "rejectedLineCount": { + "format": "int32", + "description": "The number of lines rejected for this data set.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "title": "EntityError", + "description": "The details of the error in case the entity is in a failed state.", + "allOf": [ + { + "$ref": "#/definitions/EntityError" + } + ], + "readOnly": true + } + } + }, + "DatasetUpdate": { + "title": "DatasetUpdate", + "type": "object", + "properties": { + "project": { + "title": "EntityReference", + "description": "The project, the entity is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "project": { + "title": "EntityReference", + "description": "The project, the endpoint is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "links": { + "title": "EndpointLinks", + "description": "The links for additional actions or content related to this dataset.", + "allOf": [ + { + "$ref": "#/definitions/EndpointLinks" + } + ], + "readOnly": true + }, + "properties": { + "title": "EndpointProperties", + "description": "Additional configuration options when creating a new endpoint and additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/EndpointProperties" + } + ] + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "text": { + "description": "The text used to adapt a language model for this endpoint.", + "type": "string" + }, + "model": { + "title": "EntityReference", + "description": "Information about the deployed model.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "EndpointLinks": { + "title": "EndpointLinks", + "type": "object", + "properties": { + "restInteractive": { + "description": "The REST endpoint for short requests up to 15 seconds.", + "type": "string", + "readOnly": true + }, + "restConversation": { + "description": "The REST endpoint for requests up to 60 seconds.", + "type": "string", + "readOnly": true + }, + "restDictation": { + "description": "The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks.", + "type": "string", + "readOnly": true + }, + "webSocketInteractive": { + "description": "The Speech SDK endpoint for short requests up to 15 seconds with a single final result.", + "type": "string", + "readOnly": true + }, + "webSocketConversation": { + "description": "The Speech SDK endpoint for long requests with multiple final results.", + "type": "string", + "readOnly": true + }, + "webSocketDictation": { + "description": "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks.", + "type": "string", + "readOnly": true + }, + "logs": { + "description": "The audio and transcription logs for this endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "EndpointProperties": { + "title": "EndpointProperties", + "type": "object", + "properties": { + "loggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "timeToLive": { + "description": "How long the endpoint will be kept in the system. Once the endpoint reaches the time to live\r\nafter completion (successful or failed) it will be automatically deleted. Not setting this value or setting\r\nto 0 will disable automatic deletion.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "title": "EntityError", + "description": "The details of the error in case the entity is in a failed state.", + "allOf": [ + { + "$ref": "#/definitions/EntityError" + } + ], + "readOnly": true + } + } + }, + "EndpointPropertiesUpdate": { + "title": "EndpointPropertiesUpdate", + "type": "object", + "properties": { + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions)\r\nis being used for a deployment.", + "type": "boolean" + } + } + }, + "EndpointUpdate": { + "title": "EndpointUpdate", + "type": "object", + "properties": { + "model": { + "title": "EntityReference", + "description": "Information about the deployed models.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "properties": { + "title": "EndpointPropertiesUpdate", + "description": "Additional configuration options when updating an endpoint.", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesUpdate" + } + ] + }, + "project": { + "title": "EntityReference", + "description": "The project, the entity is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EntityError": { + "title": "EntityError", + "type": "object", + "properties": { + "code": { + "description": "The code of this error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message for this error.", + "type": "string", + "readOnly": true + } + } + }, + "EntityReference": { + "title": "EntityReference", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "description": "The location of the referenced entity.", + "type": "string" + } + } + }, + "Error": { + "title": "Error", + "description": "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details.", + "type": "object", + "properties": { + "code": { + "title": "ErrorCode", + "description": "High level error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound", + "PipelineError", + "Conflict", + "InternalCommunicationFailed", + "Forbidden", + "NotAllowed", + "Unauthorized", + "UnsupportedMediaType", + "TooManyRequests" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "title": "InnerError", + "description": "Finer error details.", + "allOf": [ + { + "$ref": "#/definitions/InnerError" + } + ] + } + } + }, + "Evaluation": { + "title": "Evaluation", + "required": [ + "dataset", + "displayName", + "locale", + "model1", + "model2" + ], + "type": "object", + "properties": { + "model1": { + "title": "EntityReference", + "description": "The first model that can be used to evaluate the improvements and differences.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "model2": { + "title": "EntityReference", + "description": "The second model that can be used to evaluate the improvements and differences.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "transcription1": { + "title": "EntityReference", + "description": "Information about the transcriptions used in the evaluation with model1.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ], + "readOnly": true + }, + "transcription2": { + "title": "EntityReference", + "description": "Information about the transcriptions used in the evaluation with model2.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ], + "readOnly": true + }, + "dataset": { + "title": "EntityReference", + "description": "Information about the dataset used in the evaluation.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "links": { + "title": "Links", + "description": "The links for additional actions or content related to this evaluation.", + "allOf": [ + { + "$ref": "#/definitions/Links" + } + ], + "readOnly": true + }, + "properties": { + "title": "EvaluationProperties", + "description": "Additional configuration options when creating a new evaluation and additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/EvaluationProperties" + } + ], + "readOnly": true + }, + "project": { + "title": "EntityReference", + "description": "The project, the evaluation is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + } + } + }, + "EvaluationProperties": { + "title": "EvaluationProperties", + "type": "object", + "properties": { + "wordErrorRate2": { + "format": "double", + "description": "The word error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "wordErrorRate1": { + "format": "double", + "description": "The word error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate2": { + "format": "double", + "description": "The sentence error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceCount2": { + "format": "int32", + "description": "The number of processed sentences by model2.", + "type": "integer", + "readOnly": true + }, + "wordCount2": { + "format": "int32", + "description": "The number of processed words by model2.", + "type": "integer", + "readOnly": true + }, + "correctWordCount2": { + "format": "int32", + "description": "The number of correctly recognized words by model2.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "sentenceErrorRate1": { + "format": "double", + "description": "The sentence error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceCount1": { + "format": "int32", + "description": "The number of processed sentences by model1.", + "type": "integer", + "readOnly": true + }, + "wordCount1": { + "format": "int32", + "description": "The number of processed words by model1.", + "type": "integer", + "readOnly": true + }, + "correctWordCount1": { + "format": "int32", + "description": "The number of correctly recognized words by model1.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "title": "EntityError", + "description": "The details of the error in case the entity is in a failed state.", + "allOf": [ + { + "$ref": "#/definitions/EntityError" + } + ], + "readOnly": true + } + } + }, + "EvaluationUpdate": { + "title": "EvaluationUpdate", + "type": "object", + "properties": { + "project": { + "title": "EntityReference", + "description": "The project, the entity is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "File": { + "title": "File", + "type": "object", + "properties": { + "kind": { + "description": "The kind of this file.", + "enum": [ + "DatasetReport", + "Audio", + "LanguageData", + "PronunciationData", + "AcousticDataArchive", + "AcousticDataTranscriptionV2", + "Transcription", + "TranscriptionReport", + "EvaluationDetails" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileKind", + "modelAsString": true + } + }, + "links": { + "title": "FileLinks", + "description": "The links for additional actions or content related to this file.", + "allOf": [ + { + "$ref": "#/definitions/FileLinks" + } + ], + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "properties": { + "title": "FileProperties", + "description": "Additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/FileProperties" + } + ], + "readOnly": true + }, + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "FileLinks": { + "title": "FileLinks", + "type": "object", + "properties": { + "contentUrl": { + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "FileProperties": { + "title": "FileProperties", + "type": "object", + "properties": { + "size": { + "format": "int64", + "description": "The size of the data in bytes.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The duration in case this file is an audio file. The duration is encoded as ISO 8601\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + } + } + }, + "HealthStatus": { + "title": "HealthStatus", + "type": "object", + "properties": { + "status": { + "description": "The overall service status.", + "enum": [ + "Healthy", + "Degraded", + "Unhealthy" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": false + } + }, + "message": { + "description": "Additional messages about the current service health.", + "type": "string", + "readOnly": true + }, + "components": { + "description": "Optional subcomponents of this service and their status.", + "type": "array", + "items": { + "$ref": "#/definitions/Component" + }, + "readOnly": true + } + } + }, + "InnerError": { + "title": "InnerError", + "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", + "type": "object", + "properties": { + "code": { + "description": "Detailed error code.", + "enum": [ + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "DataImportFailed", + "InUseViolation", + "InvalidLocale", + "InvalidBaseModel", + "InvalidAdaptationMapping", + "InvalidDataset", + "InvalidTest", + "FailedDataset", + "InvalidModel", + "InvalidTranscription", + "InvalidPayload", + "InvalidParameter", + "EndpointWithoutLogging", + "InvalidPermissions", + "InvalidPrerequisite", + "InvalidProductId", + "InvalidSubscription", + "InvalidProject", + "InvalidProjectKind", + "InvalidRecordingsUri", + "OnlyOneOfUrlsOrContainerOrDataset", + "ExceededNumberOfRecordingsUris", + "ModelMismatch", + "ProjectGenderMismatch", + "ModelDeprecated", + "ModelExists", + "ModelNotDeployable", + "EndpointNotUpdatable", + "SingleDefaultEndpoint", + "EndpointCannotBeDefault", + "InvalidModelUri", + "SubscriptionNotFound", + "QuotaViolation", + "UnsupportedDelta", + "UnsupportedFilter", + "UnsupportedPagination", + "UnsupportedDynamicConfiguration", + "UnsupportedOrderBy", + "NoUtf8WithBom", + "ModelDeploymentNotCompleteState", + "SkuLimitsExist", + "DeployingFailedModel", + "UnsupportedTimeRange", + "InvalidLogDate", + "InvalidLogId", + "InvalidLogStartTime", + "InvalidLogEndTime", + "InvalidTopForLogs", + "DeleteNotAllowed", + "Forbidden", + "DeployNotAllowed", + "UnexpectedError", + "InvalidCollection", + "InvalidCallbackUri", + "InvalidSasValidityDuration", + "InaccessibleCustomerStorage", + "UnsupportedClassBasedAdaptation", + "InvalidWebHookEventKind" + ], + "type": "string", + "x-ms-enum": { + "name": "DetailedErrorCode", + "modelAsString": true + } + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "title": "InnerError", + "description": "Finer error details.", + "allOf": [ + { + "$ref": "#/definitions/InnerError" + } + ] + } + } + }, + "Links": { + "title": "Links", + "type": "object", + "properties": { + "files": { + "description": "The location to get all files of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "Model": { + "title": "Model", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "project": { + "title": "EntityReference", + "description": "The project, the model is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "links": { + "title": "ModelLinks", + "description": "The links for additional actions or content related to this model.", + "allOf": [ + { + "$ref": "#/definitions/ModelLinks" + } + ], + "readOnly": true + }, + "properties": { + "title": "ModelProperties", + "description": "Additional configuration options when creating a new model and additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/ModelProperties" + } + ] + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "title": "EntityReference", + "description": "The base model used for adaptation.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityReference" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ModelCopy": { + "title": "ModelCopy", + "required": [ + "targetSubscriptionKey" + ], + "type": "object", + "properties": { + "targetSubscriptionKey": { + "description": "The subscription key of the subscription that is the target of the copy operation.", + "type": "string" + } + } + }, + "ModelDeprecationDates": { + "title": "ModelDeprecationDates", + "type": "object", + "properties": { + "adaptationDateTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "transcriptionDateTime": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "ModelFile": { + "title": "ModelFile", + "type": "object", + "properties": { + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "contentUrl": { + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "ModelLinks": { + "title": "ModelLinks", + "type": "object", + "properties": { + "manifest": { + "description": "The location to get a manifest for this model to be used in the on-prem container.", + "type": "string", + "readOnly": true + }, + "copyTo": { + "description": "The location to the model copy action.", + "type": "string", + "readOnly": true + } + } + }, + "ModelManifest": { + "title": "ModelManifest", + "required": [ + "model", + "modelFiles", + "properties" + ], + "type": "object", + "properties": { + "model": { + "title": "EntityReference", + "description": "The model, the endpoint is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "modelFiles": { + "description": "The model files, the endpoint requires.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFile" + } + }, + "properties": { + "description": "The configuration of the endpoint.", + "type": "object", + "additionalProperties": { + "title": "Object", + "type": "object" + } + } + } + }, + "ModelProperties": { + "title": "ModelProperties", + "type": "object", + "properties": { + "deprecationDates": { + "title": "ModelDeprecationDates", + "description": "The date when features of this model become deprecated.", + "allOf": [ + { + "$ref": "#/definitions/ModelDeprecationDates" + } + ], + "readOnly": true + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "title": "EntityError", + "description": "The details of the error in case the entity is in a failed state.", + "allOf": [ + { + "$ref": "#/definitions/EntityError" + } + ], + "readOnly": true + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "type": "object", + "properties": { + "project": { + "title": "EntityReference", + "description": "The project, the entity is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PaginatedDatasets": { + "title": "PaginatedDatasets", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEndpoints": { + "title": "PaginatedEndpoints", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEvaluations": { + "title": "PaginatedEvaluations", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedFiles": { + "title": "PaginatedFiles", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedModels": { + "title": "PaginatedModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedProjects": { + "title": "PaginatedProjects", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedTranscriptions": { + "title": "PaginatedTranscriptions", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Transcription" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedWebHooks": { + "title": "PaginatedWebHooks", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/WebHook" + }, + "readOnly": true + }, + "@nextLink": { + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "Project": { + "title": "Project", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "title": "ProjectLinks", + "description": "The links for additional actions or content related to this project.", + "allOf": [ + { + "$ref": "#/definitions/ProjectLinks" + } + ], + "readOnly": true + }, + "properties": { + "title": "ProjectProperties", + "description": "Additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/ProjectProperties" + } + ], + "readOnly": true + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "ProjectLinks": { + "title": "ProjectLinks", + "type": "object", + "properties": { + "evaluations": { + "description": "The location to get a list of all evaluations of this project.", + "type": "string", + "readOnly": true + }, + "datasets": { + "description": "The location to get a list of all datasets of this project.", + "type": "string", + "readOnly": true + }, + "models": { + "description": "The location to get a list of all models of this project.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "description": "The location to get a list of all endpoints of this project.", + "type": "string", + "readOnly": true + }, + "transcriptions": { + "description": "The location to get a list of all transcriptions of this project.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectProperties": { + "title": "ProjectProperties", + "type": "object", + "properties": { + "datasetCount": { + "format": "int32", + "description": "The number of datasets associated to this project.", + "type": "integer", + "readOnly": true + }, + "evaluationCount": { + "format": "int32", + "description": "The number of evaluations associated to this project.", + "type": "integer", + "readOnly": true + }, + "modelCount": { + "format": "int32", + "description": "The number of models associated to this project.", + "type": "integer", + "readOnly": true + }, + "transcriptionCount": { + "format": "int32", + "description": "The number of transcriptions associated to this project.", + "type": "integer", + "readOnly": true + }, + "endpointCount": { + "format": "int32", + "description": "The number of endpoints associated to this project.", + "type": "integer", + "readOnly": true + } + } + }, + "ProjectUpdate": { + "title": "ProjectUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Transcription": { + "title": "Transcription", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "title": "Links", + "description": "The links for additional actions or content related to this transcription.", + "allOf": [ + { + "$ref": "#/definitions/Links" + } + ], + "readOnly": true + }, + "properties": { + "title": "TranscriptionProperties", + "description": "Additional configuration options when creating a new transcription and additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/TranscriptionProperties" + } + ] + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "model": { + "title": "EntityReference", + "description": "The model used in this transcription.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "project": { + "title": "EntityReference", + "description": "The project, the transcription is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "dataset": { + "title": "EntityReference", + "description": "A list of acoustic or audio files datasets containing the audio files that will be transcribed.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "contentUrls": { + "description": "A list of content urls to get audio files from for transcription. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.", + "type": "array", + "items": { + "type": "string" + } + }, + "contentContainerUrl": { + "description": "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response.", + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "TranscriptionProperties": { + "title": "TranscriptionProperties", + "type": "object", + "properties": { + "diarizationEnabled": { + "description": "A value indicating whether diarization (speaker separation) is requested.", + "type": "boolean" + }, + "wordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps are requested.", + "type": "boolean" + }, + "duration": { + "description": "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "channels": { + "description": "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "destinationContainerUrl": { + "description": "The requested destination container.", + "type": "string" + }, + "punctuationMode": { + "title": "PunctuationMode", + "description": "The requested punctuation mode.", + "enum": [ + "None", + "Dictated", + "Automatic", + "DictatedAndAutomatic" + ], + "type": "string", + "x-ms-enum": { + "name": "PunctuationMode", + "modelAsString": false + } + }, + "profanityFilterMode": { + "title": "ProfanityFilterMode", + "description": "The requested profanity filter mode.", + "enum": [ + "None", + "Removed", + "Tags", + "Masked" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfanityFilterMode", + "modelAsString": false + } + }, + "timeToLive": { + "description": "How long the transcription will be kept in the system. Once the transcription reaches the time to live\r\nafter completion (successful or failed) it will be automatically deleted. Not setting this value or setting\r\nto 0 will disable automatic deletion.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "title": "EntityError", + "description": "The details of the error in case the entity is in a failed state.", + "allOf": [ + { + "$ref": "#/definitions/EntityError" + } + ], + "readOnly": true + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "type": "object", + "properties": { + "project": { + "title": "EntityReference", + "description": "The project, the entity is associated with.", + "allOf": [ + { + "$ref": "#/definitions/EntityReference" + } + ] + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebHook": { + "title": "WebHook", + "required": [ + "displayName", + "events", + "webUrl" + ], + "type": "object", + "properties": { + "links": { + "title": "WebHookLinks", + "description": "The links for additional actions or content related to this webhook.", + "allOf": [ + { + "$ref": "#/definitions/WebHookLinks" + } + ], + "readOnly": true + }, + "properties": { + "title": "WebHookProperties", + "description": "Additional configuration options when creating a new webhook\r\nand additional metadata provided by the service.", + "allOf": [ + { + "$ref": "#/definitions/WebHookProperties" + } + ] + }, + "self": { + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "webUrl": { + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "events": { + "title": "WebHookEvents", + "description": "A value indicating the webhook event kinds.", + "type": "object", + "properties": { + "datasetCreation": { + "type": "boolean" + }, + "datasetProcessing": { + "type": "boolean" + }, + "datasetCompletion": { + "type": "boolean" + }, + "datasetDeletion": { + "type": "boolean" + }, + "modelCreation": { + "type": "boolean" + }, + "modelProcessing": { + "type": "boolean" + }, + "modelCompletion": { + "type": "boolean" + }, + "modelDeletion": { + "type": "boolean" + }, + "evaluationCreation": { + "type": "boolean" + }, + "evaluationProcessing": { + "type": "boolean" + }, + "evaluationCompletion": { + "type": "boolean" + }, + "evaluationDeletion": { + "type": "boolean" + }, + "transcriptionCreation": { + "type": "boolean" + }, + "transcriptionProcessing": { + "type": "boolean" + }, + "transcriptionCompletion": { + "type": "boolean" + }, + "transcriptionDeletion": { + "type": "boolean" + }, + "endpointCreation": { + "type": "boolean" + }, + "endpointProcessing": { + "type": "boolean" + }, + "endpointCompletion": { + "type": "boolean" + }, + "endpointDeletion": { + "type": "boolean" + }, + "ping": { + "type": "boolean" + }, + "challenge": { + "type": "boolean" + } + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the object.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false + } + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebHookLinks": { + "title": "WebHookLinks", + "type": "object", + "properties": { + "ping": { + "description": "The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration.", + "type": "string", + "readOnly": true + }, + "test": { + "description": "The URL that can be used sending test events to the registered URL of a web hook registration.", + "type": "string", + "readOnly": true + } + } + }, + "WebHookProperties": { + "title": "WebHookProperties", + "type": "object", + "properties": { + "error": { + "title": "EntityError", + "description": "The details of the error in case the dataset is in a failed state.", + "allOf": [ + { + "$ref": "#/definitions/EntityError" + } + ], + "readOnly": true + }, + "apiVersion": { + "description": "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\r\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\r\nthe web hook will be disabled.", + "type": "string", + "readOnly": true + }, + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookPropertiesUpdate": { + "title": "WebHookPropertiesUpdate", + "type": "object", + "properties": { + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookUpdate": { + "title": "WebHookUpdate", + "type": "object", + "properties": { + "webUrl": { + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "properties": { + "title": "WebHookPropertiesUpdate", + "description": "Additional configuration options when updating a webhook.", + "allOf": [ + { + "$ref": "#/definitions/WebHookPropertiesUpdate" + } + ] + }, + "events": { + "title": "WebHookEvents", + "description": "A value indicating the webhook event kinds.", + "type": "object", + "properties": { + "datasetCreation": { + "type": "boolean" + }, + "datasetProcessing": { + "type": "boolean" + }, + "datasetCompletion": { + "type": "boolean" + }, + "datasetDeletion": { + "type": "boolean" + }, + "modelCreation": { + "type": "boolean" + }, + "modelProcessing": { + "type": "boolean" + }, + "modelCompletion": { + "type": "boolean" + }, + "modelDeletion": { + "type": "boolean" + }, + "evaluationCreation": { + "type": "boolean" + }, + "evaluationProcessing": { + "type": "boolean" + }, + "evaluationCompletion": { + "type": "boolean" + }, + "evaluationDeletion": { + "type": "boolean" + }, + "transcriptionCreation": { + "type": "boolean" + }, + "transcriptionProcessing": { + "type": "boolean" + }, + "transcriptionCompletion": { + "type": "boolean" + }, + "transcriptionDeletion": { + "type": "boolean" + }, + "endpointCreation": { + "type": "boolean" + }, + "endpointProcessing": { + "type": "boolean" + }, + "endpointCompletion": { + "type": "boolean" + }, + "endpointDeletion": { + "type": "boolean" + }, + "ping": { + "type": "boolean" + }, + "challenge": { + "type": "boolean" + } + } + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "subscription_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services subscription key here." + }, + "token": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" + } + } +} \ No newline at end of file From 07226d2ff3f7db9ab6e9da3d6353b1479be34dc7 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 17 Feb 2021 17:02:13 +0100 Subject: [PATCH 02/34] make prettier --- .../stable/v2.0/speechtotext.json | 140 ++++----- .../stable/v3.0/speechtotext.json | 278 +++++++++--------- 2 files changed, 209 insertions(+), 209 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index b2db4c77e20a..9437571637e5 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -17,7 +17,7 @@ "$ref": "#/parameters/Endpoint" } ] - }, + }, "schemes": [ "https" ], @@ -126,8 +126,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -230,8 +230,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -372,8 +372,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -546,8 +546,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -658,8 +658,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -786,8 +786,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -896,8 +896,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1038,8 +1038,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1212,8 +1212,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1345,8 +1345,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1558,8 +1558,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -1672,8 +1672,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1782,8 +1782,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1938,8 +1938,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -2084,8 +2084,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2196,8 +2196,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2370,8 +2370,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2485,8 +2485,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2624,8 +2624,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2812,8 +2812,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -2959,8 +2959,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3103,8 +3103,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3255,8 +3255,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3365,8 +3365,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3521,8 +3521,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -3667,8 +3667,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3841,8 +3841,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3974,8 +3974,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4084,8 +4084,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4210,8 +4210,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4366,8 +4366,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -4512,8 +4512,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4686,8 +4686,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4822,8 +4822,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5760,4 +5760,4 @@ "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" } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index b5593eec6819..7d4d19ddb90d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -86,8 +86,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -168,8 +168,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -256,8 +256,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -339,8 +339,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -433,8 +433,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -505,8 +505,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -636,8 +636,8 @@ "deprecated": true, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -740,8 +740,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -836,8 +836,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -892,8 +892,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -974,8 +974,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -1062,8 +1062,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1145,8 +1145,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1217,8 +1217,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1311,8 +1311,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1414,8 +1414,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -1497,8 +1497,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -1592,8 +1592,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1671,8 +1671,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1767,8 +1767,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -1849,8 +1849,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -1943,8 +1943,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2021,8 +2021,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2077,8 +2077,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2159,8 +2159,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -2247,8 +2247,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2351,8 +2351,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -2447,8 +2447,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2530,8 +2530,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2624,8 +2624,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2696,8 +2696,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2752,8 +2752,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2834,8 +2834,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -2922,8 +2922,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2998,8 +2998,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -3085,8 +3085,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3179,8 +3179,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3251,8 +3251,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3328,8 +3328,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3430,8 +3430,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3514,8 +3514,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3598,8 +3598,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3654,8 +3654,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3730,8 +3730,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -3815,8 +3815,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3892,8 +3892,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3980,8 +3980,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4052,8 +4052,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4149,8 +4149,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4250,8 +4250,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4351,8 +4351,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4452,8 +4452,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4553,8 +4553,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4613,8 +4613,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4695,8 +4695,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4783,8 +4783,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4866,8 +4866,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4960,8 +4960,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -5032,8 +5032,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5136,8 +5136,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -5232,8 +5232,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5314,8 +5314,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -5400,8 +5400,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5483,8 +5483,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -5578,8 +5578,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -5650,8 +5650,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5736,8 +5736,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -5829,8 +5829,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -5886,8 +5886,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -8074,4 +8074,4 @@ "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" } } -} \ No newline at end of file +} From be0547722e454b70d8636c7f6f6d6dbc42a2a225 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 17 Feb 2021 17:12:24 +0100 Subject: [PATCH 03/34] Fix spelling issues and add custom words --- custom-words.txt | 8 ++++++++ .../SpeechToText/stable/v2.0/speechtotext.json | 12 ++++++------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index c98d7a947ca6..da4ee15d1bd3 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -15,6 +15,7 @@ accesskey accesspoint accountid accountname +accuracytests ACLs aclspec acquisitionid @@ -134,6 +135,7 @@ asyncinfo asyncoperation atascada attestationcollateral +audiodata Auditd australiaeast australiasoutheast @@ -379,6 +381,7 @@ contoso contosodataset contosomedia cooldown +copyto Corda coreml Corent @@ -757,6 +760,7 @@ hdinsight Headnode healthbot healthcareapis +healthstatus Heatbeat heatmap HHMM @@ -925,6 +929,7 @@ labelset labservices LACNIC Lajolla +languagedata largefacelists largepersongroups lastfile @@ -1652,6 +1657,8 @@ sparkr sparql SPDX specversion +speechtotext +speechservicesmanagement SQLAG sqldatabase SQLDB @@ -1707,6 +1714,7 @@ streamingjobs streamingservice subcause subcomponent +subcomponents subdir subdomain subexpressions diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 9437571637e5..73af6d131620 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -5077,12 +5077,12 @@ }, "startDate": { "format": "date-time", - "description": "The start date of the demplyment data export.", + "description": "The start date of the deployment data export.", "type": "string" }, "endDate": { "format": "date-time", - "description": "The end date of the demplyment data export.", + "description": "The end date of the deployment data export.", "type": "string" } } @@ -5097,12 +5097,12 @@ "properties": { "startDate": { "format": "date-time", - "description": "The start date of the demplyment data export.", + "description": "The start date of the deployment data export.", "type": "string" }, "endDate": { "format": "date-time", - "description": "The end date of the demplyment data export.", + "description": "The end date of the deployment data export.", "type": "string" } } @@ -5134,7 +5134,7 @@ "type": "object", "properties": { "details": { - "description": "An array of details representing distinct related errors that occured during the request.", + "description": "An array of details representing distinct related errors that occurred during the request.", "type": "array", "items": { "$ref": "#/definitions/ErrorDetail" @@ -5188,7 +5188,7 @@ }, "InnerErrorV2": { "title": "InnerErrorV2", - "description": "An implementation of this interface represents a stage in a stack trace.\r\nIf the error levvel is the root, the Microsoft.SpeechServices.Http.Dto.IInnerError.Code and the Microsoft.SpeechServices.Http.Dto.IInnerError.InnerError\r\nproperty may be omitted.", + "description": "An implementation of this interface represents a stage in a stack trace.\r\nIf the error level is the root, the Microsoft.SpeechServices.Http.Dto.IInnerError.Code and the Microsoft.SpeechServices.Http.Dto.IInnerError.InnerError\r\nproperty may be omitted.", "type": "object", "properties": { "code": { From d8c1b95d806bdd3419322f8d32dcefe0fed49252 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 17 Feb 2021 17:46:48 +0100 Subject: [PATCH 04/34] Provide readme.md --- .../data-plane/Speech/SpeechToText/readme.md | 103 ++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md new file mode 100644 index 000000000000..abbec63e686d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -0,0 +1,103 @@ +# Cognitive Services SpeechToText SDKs + +> see https://aka.ms/autorest + +Configuration for generating SpeechToText SDK. + +``` yaml +tag: 3_0 +add-credentials: true +openapi-type: data-plane +``` + +The current release for the SpeechToText is `3_0`. + +# Releases + +## SpeechToText 2.0 +These settings apply only when `--tag=2_0` is specified on the command line. + +``` yaml $(tag) == '2_0' +input-file: stable/v2.0/speechtotext.json +``` + +--- + +## SpeechToText 3.0 +These settings apply only when `--tag=3_0` is specified on the command line. + +``` yaml $(tag) == '3_0' +input-file: stable/v3.0/speechtotext.json +``` + +--- + +# Code Generation + + +## 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-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +### 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.CognitiveServices.Speech.SpeechToText + output-folder: $(csharp-sdks-folder)/CognitiveServices/Speech/SpeechToText/src/generated + clear-output-folder: true +``` + +## 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.cognitiveservices.speech.speechtotext + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/speech/speechtotext + with-optional-parameters: true + with-single-async-method: true +``` + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/stable/v2.0/speechtotext.json + - $(this-folder)/stable/v3.0/speechtotext.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` + From 5a3156e5aa79d5231030c9e687477383625c7d94 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 17 Feb 2021 18:03:46 +0100 Subject: [PATCH 05/34] added go and js sdk --- .../Speech/SpeechToText/readme.go.md | 36 +++++++++++++++++++ .../Speech/SpeechToText/readme.nodejs.md | 14 ++++++++ 2 files changed, 50 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.nodejs.md diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md new file mode 100644 index 000000000000..4985d56241e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md @@ -0,0 +1,36 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: authoring + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 2_0 + - tag: 3_0 +``` + +### Tag: 2_0 and go + +These settings apply only when `--tag=2_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '2_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/speech/speechtotext/$(namespace) +``` + +### Tag: 3_0 and go + +These settings apply only when `--tag=3_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '3_0' && $(go) +output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0/speech/speechtotext/$(namespace) +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.nodejs.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.nodejs.md new file mode 100644 index 000000000000..a1ed1ba4e04e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/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-speech-speechtotext + output-folder: $(node-sdks-folder)/lib/services/speech/speechtotext/authoring + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` From a1478e9fb676fec9cbe051b7e9d10b244ab578cc Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 17 Feb 2021 18:38:43 +0100 Subject: [PATCH 06/34] adding typescript --- .../Speech/SpeechToText/readme.typescript.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.typescript.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.typescript.md new file mode 100644 index 000000000000..399bdee3e157 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/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-speech-speechtotext" + output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-speech-speechtotext" + azure-arm: false + generate-metadata: true +``` From a80a3723e8b550d38cc5e475d0ae92c4068124ec Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 07:36:41 +0100 Subject: [PATCH 07/34] make tag more verbose --- .../Speech/SpeechToText/readme.go.md | 12 ++++++------ .../data-plane/Speech/SpeechToText/readme.md | 18 +++++++++++------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md index 4985d56241e5..3c2e44b793e1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md @@ -13,24 +13,24 @@ go: ``` yaml $(go) && $(multiapi) batch: - - tag: 2_0 - - tag: 3_0 + - tag: release_2_0 + - tag: release_3_0 ``` ### Tag: 2_0 and go -These settings apply only when `--tag=2_0 --go` is specified on the command line. +These settings apply only when `--tag=release_2_0 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == '2_0' && $(go) +``` yaml $(tag) == 'release_2_0' && $(go) output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/speech/speechtotext/$(namespace) ``` ### Tag: 3_0 and go -These settings apply only when `--tag=3_0 --go` is specified on the command line. +These settings apply only when `--tag=release_3_0 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == '3_0' && $(go) +``` yaml $(tag) == 'release_3_0' && $(go) output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0/speech/speechtotext/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index abbec63e686d..e99d8f0bccd5 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -4,29 +4,29 @@ Configuration for generating SpeechToText SDK. +The current release for the SpeechToText is `release_3_0`. + ``` yaml -tag: 3_0 +tag: release_3_0 add-credentials: true openapi-type: data-plane ``` -The current release for the SpeechToText is `3_0`. - # Releases ## SpeechToText 2.0 -These settings apply only when `--tag=2_0` is specified on the command line. +These settings apply only when `--tag=release_2_0` is specified on the command line. -``` yaml $(tag) == '2_0' +``` yaml $(tag) == 'release_2_0' input-file: stable/v2.0/speechtotext.json ``` --- ## SpeechToText 3.0 -These settings apply only when `--tag=3_0` is specified on the command line. +These settings apply only when `--tag=release_3_0` is specified on the command line. -``` yaml $(tag) == '3_0' +``` yaml $(tag) == 'release_3_0' input-file: stable/v3.0/speechtotext.json ``` @@ -60,6 +60,10 @@ csharp: 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. From 9f06074b28ea0bd0aabdd6d335835b2891aba903 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 08:20:22 +0100 Subject: [PATCH 08/34] fix duplicate schema names --- .../SpeechToText/stable/v3.0/speechtotext.json | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 7d4d19ddb90d..605f1396bdd5 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -1500,11 +1500,7 @@ "subscription_key": [], "token": [] } - ], - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } + ] } }, "/endpoints/{id}/files/logs/{logId}": { @@ -1852,11 +1848,7 @@ "subscription_key": [], "token": [] } - ], - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } + ] } }, "/endpoints/base/{locale}/files/logs/{logId}": { @@ -5853,7 +5845,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HealthStatus" + "$ref": "#/definitions/ServiceHealth" } }, "401": { @@ -6793,7 +6785,7 @@ } } }, - "HealthStatus": { + "ServiceHealth": { "title": "HealthStatus", "type": "object", "properties": { From 92cddc4a5f6d0faf26b2c8da1b15b6d0f0a5e768 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 08:52:38 +0100 Subject: [PATCH 09/34] do not use anonymous type --- .../Speech/SpeechToText/stable/v2.0/speechtotext.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 73af6d131620..19f85d6ad30d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -678,7 +678,6 @@ "200": { "description": "OK", "schema": { - "title": "IReadOnlyDictionary`2", "type": "object", "properties": { "Language": { @@ -3123,7 +3122,6 @@ "200": { "description": "OK", "schema": { - "title": "IReadOnlyDictionary`2", "type": "object", "properties": { "None": { From 763c0b2aac4b62b3a33b96facd9bbb4d4288d11a Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 09:09:15 +0100 Subject: [PATCH 10/34] name dictionaries --- .../Speech/SpeechToText/stable/v2.0/speechtotext.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 19f85d6ad30d..75d2293a9073 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -678,6 +678,7 @@ "200": { "description": "OK", "schema": { + "title": "SupportedDatasetLocales", "type": "object", "properties": { "Language": { @@ -3122,6 +3123,7 @@ "200": { "description": "OK", "schema": { + "title": "SupportedModelLocales", "type": "object", "properties": { "None": { From 039edfa9ec10e0e489661b42b3b8532fd29824b3 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 14:14:35 +0100 Subject: [PATCH 11/34] Extract inline schemas --- .../stable/v2.0/speechtotext.json | 292 ++++++------- .../stable/v3.0/speechtotext.json | 385 +++++++++--------- 2 files changed, 340 insertions(+), 337 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 75d2293a9073..03a82664a8dc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -126,8 +126,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -230,8 +230,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -372,8 +372,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -546,8 +546,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -658,8 +658,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -678,28 +678,7 @@ "200": { "description": "OK", "schema": { - "title": "SupportedDatasetLocales", - "type": "object", - "properties": { - "Language": { - "type": "array", - "items": { - "type": "string" - } - }, - "Acoustic": { - "type": "array", - "items": { - "type": "string" - } - }, - "Pronunciation": { - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/definitions/DatasetLocales" }, "headers": { "X-RateLimit-Limit": { @@ -786,8 +765,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -896,8 +875,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1038,8 +1017,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -1212,8 +1191,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -1345,8 +1324,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1558,8 +1537,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -1672,8 +1651,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1782,8 +1761,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -1938,8 +1917,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -2084,8 +2063,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2196,8 +2175,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2370,8 +2349,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2485,8 +2464,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2624,8 +2603,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2812,8 +2791,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -2959,8 +2938,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -3103,8 +3082,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3123,52 +3102,7 @@ "200": { "description": "OK", "schema": { - "title": "SupportedModelLocales", - "type": "object", - "properties": { - "None": { - "type": "array", - "items": { - "type": "string" - } - }, - "Acoustic": { - "type": "array", - "items": { - "type": "string" - } - }, - "Language": { - "type": "array", - "items": { - "type": "string" - } - }, - "AcousticAndLanguage": { - "type": "array", - "items": { - "type": "string" - } - }, - "Sentiment": { - "type": "array", - "items": { - "type": "string" - } - }, - "Diarization": { - "type": "array", - "items": { - "type": "string" - } - }, - "PronunciationScore": { - "type": "array", - "items": { - "type": "string" - } - } - } + "$ref": "#/definitions/ModelLocales" }, "headers": { "X-RateLimit-Limit": { @@ -3255,8 +3189,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3365,8 +3299,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -3521,8 +3455,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -3667,8 +3601,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -3841,8 +3775,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -3974,8 +3908,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -4084,8 +4018,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -4210,8 +4144,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -4366,8 +4300,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -4512,8 +4446,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -4686,8 +4620,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -4822,8 +4756,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -4917,6 +4851,30 @@ } } }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "properties": { + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Pronunciation": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, "DatasetUpdate": { "title": "DatasetUpdate", "required": [ @@ -5230,15 +5188,12 @@ "type": "string" }, "modelKind": { + "title": "ModelKind", "description": "The kind of this model (e.g. acoustic, language ...)", "enum": [ - "None", "Acoustic", "Language", - "AcousticAndLanguage", - "Sentiment", - "Diarization", - "PronunciationScore" + "AcousticAndLanguage" ], "type": "string" }, @@ -5316,6 +5271,54 @@ } } }, + "ModelLocales": { + "title": "ModelLocales", + "type": "object", + "properties": { + "None": { + "type": "array", + "items": { + "type": "string" + } + }, + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "AcousticAndLanguage": { + "type": "array", + "items": { + "type": "string" + } + }, + "Sentiment": { + "type": "array", + "items": { + "type": "string" + } + }, + "Diarization": { + "type": "array", + "items": { + "type": "string" + } + }, + "PronunciationScore": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, "ModelUpdate": { "title": "ModelUpdate", "required": [ @@ -5391,15 +5394,12 @@ "type": "object", "properties": { "modelKind": { + "title": "ModelKind", "description": "The kind of this model (e.g. acoustic, language ...)", "enum": [ - "None", "Acoustic", "Language", - "AcousticAndLanguage", - "Sentiment", - "Diarization", - "PronunciationScore" + "AcousticAndLanguage" ], "type": "string" }, diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 605f1396bdd5..c499dd997b01 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -36,24 +36,7 @@ "200": { "description": "OK", "schema": { - "title": "DatasetLocales", - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "enum": [ - "Language", - "Acoustic", - "Pronunciation", - "AudioFiles" - ], - "type": "string", - "x-ms-enum": { - "name": "DatasetKind", - "modelAsString": false - } - } - } + "$ref": "#/definitions/DatasetLocales" } }, "401": { @@ -86,8 +69,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -168,8 +151,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -256,8 +239,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -339,8 +322,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -433,8 +416,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -505,8 +488,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -636,8 +619,8 @@ "deprecated": true, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -740,8 +723,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -836,8 +819,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -892,8 +875,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -974,8 +957,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -1062,8 +1045,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1145,8 +1128,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -1217,8 +1200,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -1311,8 +1294,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1414,8 +1397,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -1497,8 +1480,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1588,8 +1571,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -1667,8 +1650,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1763,8 +1746,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -1845,8 +1828,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1935,8 +1918,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2013,8 +1996,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2069,8 +2052,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2151,8 +2134,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -2239,8 +2222,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2343,8 +2326,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -2439,8 +2422,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2522,8 +2505,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2616,8 +2599,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2688,8 +2671,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2744,8 +2727,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2826,8 +2809,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -2914,8 +2897,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -2990,8 +2973,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -3077,8 +3060,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -3171,8 +3154,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -3243,8 +3226,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3320,8 +3303,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3422,8 +3405,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3506,8 +3489,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3590,8 +3573,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3646,8 +3629,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3722,8 +3705,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -3807,8 +3790,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3884,8 +3867,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -3972,8 +3955,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -4044,8 +4027,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -4141,8 +4124,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -4242,8 +4225,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -4343,8 +4326,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -4444,8 +4427,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -4545,8 +4528,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -4605,8 +4588,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -4687,8 +4670,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -4775,8 +4758,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -4858,8 +4841,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -4952,8 +4935,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -5024,8 +5007,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -5128,8 +5111,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -5224,8 +5207,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -5306,8 +5289,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-pageable": { @@ -5392,8 +5375,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -5475,8 +5458,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -5570,8 +5553,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -5642,8 +5625,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -5728,8 +5711,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -5821,8 +5804,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -5878,8 +5861,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -5903,9 +5886,9 @@ "status": { "description": "The health status of this component.", "enum": [ - "Healthy", + "Unhealthy", "Degraded", - "Unhealthy" + "Healthy" ], "type": "string", "readOnly": true, @@ -6029,6 +6012,26 @@ } } }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": false + } + } + } + }, "DatasetProperties": { "title": "DatasetProperties", "type": "object", @@ -6785,39 +6788,6 @@ } } }, - "ServiceHealth": { - "title": "HealthStatus", - "type": "object", - "properties": { - "status": { - "description": "The overall service status.", - "enum": [ - "Healthy", - "Degraded", - "Unhealthy" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "HealthStatus", - "modelAsString": false - } - }, - "message": { - "description": "Additional messages about the current service health.", - "type": "string", - "readOnly": true - }, - "components": { - "description": "Optional subcomponents of this service and their status.", - "type": "array", - "items": { - "$ref": "#/definitions/Component" - }, - "readOnly": true - } - } - }, "InnerError": { "title": "InnerError", "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", @@ -7501,6 +7471,39 @@ } } }, + "ServiceHealth": { + "title": "ServiceHealth", + "type": "object", + "properties": { + "status": { + "description": "The overall service status.", + "enum": [ + "Unhealthy", + "Degraded", + "Healthy" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": false + } + }, + "message": { + "description": "Additional messages about the current service health.", + "type": "string", + "readOnly": true + }, + "components": { + "description": "Optional subcomponents of this service and their status.", + "type": "array", + "items": { + "$ref": "#/definitions/Component" + }, + "readOnly": true + } + } + }, "Transcription": { "title": "Transcription", "required": [ From f4bb77e939ac32c8506c732ac559e11264b65864 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 14:16:19 +0100 Subject: [PATCH 12/34] prettify again --- .../stable/v2.0/speechtotext.json | 136 ++++----- .../stable/v3.0/speechtotext.json | 276 +++++++++--------- 2 files changed, 206 insertions(+), 206 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 03a82664a8dc..231eb917ca29 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -126,8 +126,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -230,8 +230,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -372,8 +372,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -546,8 +546,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -658,8 +658,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -765,8 +765,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -875,8 +875,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1017,8 +1017,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1191,8 +1191,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1324,8 +1324,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1537,8 +1537,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -1651,8 +1651,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1761,8 +1761,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1917,8 +1917,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -2063,8 +2063,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2175,8 +2175,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2349,8 +2349,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2464,8 +2464,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2603,8 +2603,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2791,8 +2791,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -2938,8 +2938,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3082,8 +3082,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3189,8 +3189,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3299,8 +3299,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3455,8 +3455,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -3601,8 +3601,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3775,8 +3775,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3908,8 +3908,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4018,8 +4018,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4144,8 +4144,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4300,8 +4300,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -4446,8 +4446,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4620,8 +4620,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4756,8 +4756,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index c499dd997b01..92ed463d50b9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -69,8 +69,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -151,8 +151,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -239,8 +239,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -322,8 +322,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -416,8 +416,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -488,8 +488,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -619,8 +619,8 @@ "deprecated": true, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -723,8 +723,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -819,8 +819,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -875,8 +875,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -957,8 +957,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -1045,8 +1045,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1128,8 +1128,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1200,8 +1200,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1294,8 +1294,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1397,8 +1397,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -1480,8 +1480,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1571,8 +1571,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1650,8 +1650,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1746,8 +1746,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -1828,8 +1828,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1918,8 +1918,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -1996,8 +1996,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2052,8 +2052,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2134,8 +2134,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -2222,8 +2222,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2326,8 +2326,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -2422,8 +2422,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2505,8 +2505,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2599,8 +2599,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2671,8 +2671,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2727,8 +2727,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2809,8 +2809,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -2897,8 +2897,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -2973,8 +2973,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -3060,8 +3060,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3154,8 +3154,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3226,8 +3226,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3303,8 +3303,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3405,8 +3405,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3489,8 +3489,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3573,8 +3573,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3629,8 +3629,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3705,8 +3705,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -3790,8 +3790,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -3867,8 +3867,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3955,8 +3955,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4027,8 +4027,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4124,8 +4124,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4225,8 +4225,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4326,8 +4326,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4427,8 +4427,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4528,8 +4528,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4588,8 +4588,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4670,8 +4670,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -4758,8 +4758,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4841,8 +4841,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -4935,8 +4935,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -5007,8 +5007,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5111,8 +5111,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -5207,8 +5207,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5289,8 +5289,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-pageable": { @@ -5375,8 +5375,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5458,8 +5458,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -5553,8 +5553,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -5625,8 +5625,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -5711,8 +5711,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -5804,8 +5804,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -5861,8 +5861,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } From d1266763eeaebdff58cd9794b269cef543730b61 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 14:26:24 +0100 Subject: [PATCH 13/34] do not leak internal enum values --- .../stable/v2.0/speechtotext.json | 24 ------------------- 1 file changed, 24 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 231eb917ca29..5d71a70ea529 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -5275,12 +5275,6 @@ "title": "ModelLocales", "type": "object", "properties": { - "None": { - "type": "array", - "items": { - "type": "string" - } - }, "Acoustic": { "type": "array", "items": { @@ -5298,24 +5292,6 @@ "items": { "type": "string" } - }, - "Sentiment": { - "type": "array", - "items": { - "type": "string" - } - }, - "Diarization": { - "type": "array", - "items": { - "type": "string" - } - }, - "PronunciationScore": { - "type": "array", - "items": { - "type": "string" - } } } }, From b4503fe1fa4da03f3be65083bba174d15895adb8 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 14:47:08 +0100 Subject: [PATCH 14/34] suppress v2 incorrectly cased property names --- .../data-plane/Speech/SpeechToText/readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index e99d8f0bccd5..adb221a666a0 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -21,6 +21,15 @@ These settings apply only when `--tag=release_2_0` is specified on the command l input-file: stable/v2.0/speechtotext.json ``` +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Changing casing will break existing clients/consumers +``` + --- ## SpeechToText 3.0 From 6c7eee586facd4ebabb1ccbefb2e34d4398caffa Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 19:04:12 +0100 Subject: [PATCH 15/34] add suppressions for linter and clean up v2 schema --- .../data-plane/Speech/SpeechToText/readme.md | 11 ++++++++ .../stable/v2.0/speechtotext.json | 27 ++++++++++++++----- 2 files changed, 31 insertions(+), 7 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index adb221a666a0..ea2c930756c0 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -28,6 +28,8 @@ AutoRest-Linter Suppressions directive: - suppress: DefinitionsPropertiesNamesCamelCase reason: Changing casing will break existing clients/consumers + - suppress: GuidUsage + reason: Changing casing will break existing clients/consumers ``` --- @@ -39,6 +41,15 @@ These settings apply only when `--tag=release_3_0` is specified on the command l input-file: stable/v3.0/speechtotext.json ``` +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: LongRunningOperationsWithLongRunningExtension + reason: Does not apply in those two places. The method is a DELETE which lazily deletes blobs, so it's Accepted, not NoContent. +``` + --- # Code Generation diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 5d71a70ea529..dc7f2083769e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -4782,12 +4782,15 @@ "dataImportKind": { "description": "The kind of the dataset (e.g. acoustic data, language data ...)", "enum": [ - "None", "Language", "Acoustic", "Pronunciation" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": false + } }, "name": { "description": "The name of the object.", @@ -4935,7 +4938,11 @@ "SpeechRecognition", "PronunciationScore" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "EndpointKind", + "modelAsString": false + } }, "lastActionDateTime": { "format": "date-time", @@ -5188,14 +5195,17 @@ "type": "string" }, "modelKind": { - "title": "ModelKind", "description": "The kind of this model (e.g. acoustic, language ...)", "enum": [ "Acoustic", "Language", "AcousticAndLanguage" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "ModelKind", + "modelAsString": false + } }, "text": { "description": "The text used to adapt this language model.", @@ -5370,14 +5380,17 @@ "type": "object", "properties": { "modelKind": { - "title": "ModelKind", "description": "The kind of this model (e.g. acoustic, language ...)", "enum": [ "Acoustic", "Language", "AcousticAndLanguage" ], - "type": "string" + "type": "string", + "x-ms-enum": { + "name": "ModelKind", + "modelAsString": false + } }, "text": { "description": "The text used to adapt this language model.", From bb3ef919519a4bebb7ea55d64c013c7247087760 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 19:14:38 +0100 Subject: [PATCH 16/34] fix go tags --- .../data-plane/Speech/SpeechToText/readme.go.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md index 3c2e44b793e1..00ecb804db8b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md @@ -17,7 +17,7 @@ batch: - tag: release_3_0 ``` -### Tag: 2_0 and go +### 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=`. @@ -26,7 +26,7 @@ Please also specify `--go-sdk-folder=`. From 79643c885c49f5893346cc41603abbd40abba806 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 18 Feb 2021 19:35:38 +0100 Subject: [PATCH 17/34] more go readme cleanups --- .../data-plane/Speech/SpeechToText/readme.go.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md index 00ecb804db8b..5bdbe08bf146 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line. ``` yaml $(go) go: license-header: MICROSOFT_APACHE_NO_VERSION - namespace: authoring + namespace: speechtotext clear-output-folder: true ``` @@ -23,7 +23,7 @@ These settings apply only when `--tag=release_2_0 --go` is specified on the comm Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'release_2_0' && $(go) -output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/speech/speechtotext/$(namespace) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/speech/$(namespace) ``` ### Tag: release_3_0 and go @@ -32,5 +32,5 @@ These settings apply only when `--tag=release_3_0 --go` is specified on the comm Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'release_3_0' && $(go) -output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0/speech/speechtotext/$(namespace) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.0/speech/$(namespace) ``` \ No newline at end of file From 37092f480b3343a63ef2c94d908492d46b91e789 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Fri, 19 Feb 2021 07:24:32 +0100 Subject: [PATCH 18/34] remove sdk generation --- .../Speech/SpeechToText/readme.go.md | 36 --------- .../data-plane/Speech/SpeechToText/readme.md | 78 +------------------ .../Speech/SpeechToText/readme.nodejs.md | 14 ---- .../Speech/SpeechToText/readme.typescript.md | 12 --- 4 files changed, 1 insertion(+), 139 deletions(-) delete mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md delete mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.nodejs.md delete mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md deleted file mode 100644 index 5bdbe08bf146..000000000000 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.go.md +++ /dev/null @@ -1,36 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: speechtotext - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: release_2_0 - - tag: release_3_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/speech/$(namespace) -``` - -### Tag: release_3_0 and go - -These settings apply only when `--tag=release_3_0 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'release_3_0' && $(go) -output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.0/speech/$(namespace) -``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index ea2c930756c0..e8a06eb3cb7e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -48,80 +48,4 @@ AutoRest-Linter Suppressions directive: - suppress: LongRunningOperationsWithLongRunningExtension reason: Does not apply in those two places. The method is a DELETE which lazily deletes blobs, so it's Accepted, not NoContent. -``` - ---- - -# Code Generation - - -## 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-go - - repo: azure-sdk-for-python - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -### 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.CognitiveServices.Speech.SpeechToText - output-folder: $(csharp-sdks-folder)/CognitiveServices/Speech/SpeechToText/src/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.cognitiveservices.speech.speechtotext - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/speech/speechtotext - with-optional-parameters: true - with-single-async-method: true -``` - -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/stable/v2.0/speechtotext.json - - $(this-folder)/stable/v3.0/speechtotext.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.nodejs.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.nodejs.md deleted file mode 100644 index a1ed1ba4e04e..000000000000 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.nodejs.md +++ /dev/null @@ -1,14 +0,0 @@ -## 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-speech-speechtotext - output-folder: $(node-sdks-folder)/lib/services/speech/speechtotext/authoring - azure-arm: false - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.typescript.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.typescript.md deleted file mode 100644 index 399bdee3e157..000000000000 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.typescript.md +++ /dev/null @@ -1,12 +0,0 @@ -## 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-speech-speechtotext" - output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-speech-speechtotext" - azure-arm: false - generate-metadata: true -``` From e45d61fe3b5c3d1d51e9e6412fd609b7a62f2251 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Fri, 19 Feb 2021 08:29:00 +0100 Subject: [PATCH 19/34] do not use allof for schema references. --- .../stable/v2.0/speechtotext.json | 118 +---- .../stable/v3.0/speechtotext.json | 460 +++--------------- 2 files changed, 72 insertions(+), 506 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index dc7f2083769e..ff0ddccae9e9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -150,12 +150,7 @@ "description": "The details of the new accuracy test.", "required": true, "schema": { - "title": "TestDefinition", - "allOf": [ - { - "$ref": "#/definitions/TestDefinition" - } - ] + "$ref": "#/definitions/TestDefinition" } } ], @@ -404,12 +399,7 @@ "description": "The object containing the updated fields of the test.", "required": true, "schema": { - "title": "TestUpdate", - "allOf": [ - { - "$ref": "#/definitions/TestUpdate" - } - ] + "$ref": "#/definitions/TestUpdate" } } ], @@ -1049,12 +1039,7 @@ "description": "The updated values for the dataset.", "required": true, "schema": { - "title": "DatasetUpdate", - "allOf": [ - { - "$ref": "#/definitions/DatasetUpdate" - } - ] + "$ref": "#/definitions/DatasetUpdate" } } ], @@ -1785,12 +1770,7 @@ "description": "The details of the endpoint.", "required": true, "schema": { - "title": "SpeechEndpointDefinition", - "allOf": [ - { - "$ref": "#/definitions/SpeechEndpointDefinition" - } - ] + "$ref": "#/definitions/SpeechEndpointDefinition" } } ], @@ -2207,12 +2187,7 @@ "description": "The updated values for the endpoint.", "required": true, "schema": { - "title": "EndpointMetadataUpdate", - "allOf": [ - { - "$ref": "#/definitions/EndpointMetadataUpdate" - } - ] + "$ref": "#/definitions/EndpointMetadataUpdate" } } ], @@ -2635,12 +2610,7 @@ "description": "The details of the new endpoint data export.", "required": true, "schema": { - "title": "EndpointDataDefinition", - "allOf": [ - { - "$ref": "#/definitions/EndpointDataDefinition" - } - ] + "$ref": "#/definitions/EndpointDataDefinition" } } ], @@ -3323,12 +3293,7 @@ "description": "The details of the new model.", "required": true, "schema": { - "title": "SpeechModelDefinition", - "allOf": [ - { - "$ref": "#/definitions/SpeechModelDefinition" - } - ] + "$ref": "#/definitions/SpeechModelDefinition" } } ], @@ -3633,12 +3598,7 @@ "description": "The updated values for the model.", "required": true, "schema": { - "title": "ModelUpdate", - "allOf": [ - { - "$ref": "#/definitions/ModelUpdate" - } - ] + "$ref": "#/definitions/ModelUpdate" } } ], @@ -4168,12 +4128,7 @@ "description": "The details of the new transcription.", "required": true, "schema": { - "title": "TranscriptionDefinition", - "allOf": [ - { - "$ref": "#/definitions/TranscriptionDefinition" - } - ] + "$ref": "#/definitions/TranscriptionDefinition" } } ], @@ -4478,12 +4433,7 @@ "description": "The updated values for the transcription.", "required": true, "schema": { - "title": "TranscriptionUpdate", - "allOf": [ - { - "$ref": "#/definitions/TranscriptionUpdate" - } - ] + "$ref": "#/definitions/TranscriptionUpdate" } } ], @@ -5106,13 +5056,7 @@ } }, "innererror": { - "title": "InnerErrorV2", - "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.", - "allOf": [ - { - "$ref": "#/definitions/InnerErrorV2" - } - ] + "$ref": "#/definitions/InnerErrorV2" }, "code": { "description": "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response.", @@ -5161,13 +5105,7 @@ "type": "string" }, "innererror": { - "title": "InnerErrorV2", - "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.", - "allOf": [ - { - "$ref": "#/definitions/InnerErrorV2" - } - ] + "$ref": "#/definitions/InnerErrorV2" } } }, @@ -5212,13 +5150,7 @@ "type": "string" }, "baseModel": { - "title": "Model", - "description": "The base model used for adaptation.", - "allOf": [ - { - "$ref": "#/definitions/Model" - } - ] + "$ref": "#/definitions/Model" }, "datasets": { "description": "Datasets used for adaptation.", @@ -5397,13 +5329,7 @@ "type": "string" }, "baseModel": { - "title": "ModelIdentity", - "description": "The base model used for adaptation.", - "allOf": [ - { - "$ref": "#/definitions/ModelIdentity" - } - ] + "$ref": "#/definitions/ModelIdentity" }, "datasets": { "description": "Datasets used for adaptation.", @@ -5493,13 +5419,7 @@ } }, "dataset": { - "title": "Dataset", - "description": "Information about the dataset used in the test.", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ] + "$ref": "#/definitions/Dataset" }, "name": { "description": "The name of the object.", @@ -5534,13 +5454,7 @@ } }, "dataset": { - "title": "DatasetIdentity", - "description": "Information about the dataset used in the test.", - "allOf": [ - { - "$ref": "#/definitions/DatasetIdentity" - } - ] + "$ref": "#/definitions/DatasetIdentity" }, "name": { "description": "The name of the object.", diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 92ed463d50b9..d31cb3cd1702 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -179,12 +179,7 @@ "description": "Definition for the new dataset.", "required": true, "schema": { - "title": "Dataset", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ] + "$ref": "#/definitions/Dataset" } } ], @@ -985,12 +980,7 @@ "description": "The details of the endpoint.", "required": true, "schema": { - "title": "Endpoint", - "allOf": [ - { - "$ref": "#/definitions/Endpoint" - } - ] + "$ref": "#/definitions/Endpoint" } } ], @@ -2162,12 +2152,7 @@ "description": "The details of the new evaluation.", "required": true, "schema": { - "title": "Evaluation", - "allOf": [ - { - "$ref": "#/definitions/Evaluation" - } - ] + "$ref": "#/definitions/Evaluation" } } ], @@ -2837,12 +2822,7 @@ "description": "The details of the new model.", "required": true, "schema": { - "title": "Model", - "allOf": [ - { - "$ref": "#/definitions/Model" - } - ] + "$ref": "#/definitions/Model" } } ], @@ -3338,12 +3318,7 @@ "description": "The body contains the subscription key of the target subscription.", "required": true, "schema": { - "title": "ModelCopy", - "allOf": [ - { - "$ref": "#/definitions/ModelCopy" - } - ] + "$ref": "#/definitions/ModelCopy" } } ], @@ -3733,12 +3708,7 @@ "description": "The details of the project.", "required": true, "schema": { - "title": "Project", - "allOf": [ - { - "$ref": "#/definitions/Project" - } - ] + "$ref": "#/definitions/Project" } } ], @@ -4698,12 +4668,7 @@ "description": "The details of the new transcription.", "required": true, "schema": { - "title": "Transcription", - "allOf": [ - { - "$ref": "#/definitions/Transcription" - } - ] + "$ref": "#/definitions/Transcription" } } ], @@ -5318,12 +5283,7 @@ "description": "The details of the new web hook.", "required": true, "schema": { - "title": "WebHook", - "allOf": [ - { - "$ref": "#/definitions/WebHook" - } - ] + "$ref": "#/definitions/WebHook" } } ], @@ -5914,23 +5874,10 @@ "type": "object", "properties": { "links": { - "title": "Links", - "description": "The links for additional actions or content related to this dataset.", - "allOf": [ - { - "$ref": "#/definitions/Links" - } - ], - "readOnly": true + "$ref": "#/definitions/Links" }, "properties": { - "title": "DatasetProperties", - "description": "Additional configuration options when creating a new dataset and additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/DatasetProperties" - } - ] + "$ref": "#/definitions/DatasetProperties" }, "kind": { "description": "The kind of the dataset.", @@ -5960,13 +5907,7 @@ "type": "string" }, "project": { - "title": "EntityReference", - "description": "The project, the dataset is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "contentUrl": { "description": "The URL of the data for the dataset.", @@ -6058,14 +5999,7 @@ "type": "string" }, "error": { - "title": "EntityError", - "description": "The details of the error in case the entity is in a failed state.", - "allOf": [ - { - "$ref": "#/definitions/EntityError" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityError" } } }, @@ -6074,13 +6008,7 @@ "type": "object", "properties": { "project": { - "title": "EntityReference", - "description": "The project, the entity is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "displayName": { "description": "The name of the object.", @@ -6108,32 +6036,13 @@ "type": "object", "properties": { "project": { - "title": "EntityReference", - "description": "The project, the endpoint is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "links": { - "title": "EndpointLinks", - "description": "The links for additional actions or content related to this dataset.", - "allOf": [ - { - "$ref": "#/definitions/EndpointLinks" - } - ], - "readOnly": true + "$ref": "#/definitions/EndpointLinks" }, "properties": { - "title": "EndpointProperties", - "description": "Additional configuration options when creating a new endpoint and additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/EndpointProperties" - } - ] + "$ref": "#/definitions/EndpointProperties" }, "self": { "description": "The location of this entity.", @@ -6153,13 +6062,7 @@ "type": "string" }, "model": { - "title": "EntityReference", - "description": "Information about the deployed model.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "locale": { "description": "The locale of the contained data.", @@ -6259,14 +6162,7 @@ "type": "string" }, "error": { - "title": "EntityError", - "description": "The details of the error in case the entity is in a failed state.", - "allOf": [ - { - "$ref": "#/definitions/EntityError" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityError" } } }, @@ -6285,31 +6181,13 @@ "type": "object", "properties": { "model": { - "title": "EntityReference", - "description": "Information about the deployed models.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "properties": { - "title": "EndpointPropertiesUpdate", - "description": "Additional configuration options when updating an endpoint.", - "allOf": [ - { - "$ref": "#/definitions/EndpointPropertiesUpdate" - } - ] + "$ref": "#/definitions/EndpointPropertiesUpdate" }, "project": { - "title": "EntityReference", - "description": "The project, the entity is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "displayName": { "description": "The name of the object.", @@ -6402,13 +6280,7 @@ "type": "string" }, "innerError": { - "title": "InnerError", - "description": "Finer error details.", - "allOf": [ - { - "$ref": "#/definitions/InnerError" - } - ] + "$ref": "#/definitions/InnerError" } } }, @@ -6424,80 +6296,28 @@ "type": "object", "properties": { "model1": { - "title": "EntityReference", - "description": "The first model that can be used to evaluate the improvements and differences.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "model2": { - "title": "EntityReference", - "description": "The second model that can be used to evaluate the improvements and differences.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "transcription1": { - "title": "EntityReference", - "description": "Information about the transcriptions used in the evaluation with model1.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityReference" }, "transcription2": { - "title": "EntityReference", - "description": "Information about the transcriptions used in the evaluation with model2.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityReference" }, "dataset": { - "title": "EntityReference", - "description": "Information about the dataset used in the evaluation.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "links": { - "title": "Links", - "description": "The links for additional actions or content related to this evaluation.", - "allOf": [ - { - "$ref": "#/definitions/Links" - } - ], - "readOnly": true + "$ref": "#/definitions/Links" }, "properties": { - "title": "EvaluationProperties", - "description": "Additional configuration options when creating a new evaluation and additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/EvaluationProperties" - } - ], - "readOnly": true + "$ref": "#/definitions/EvaluationProperties" }, "project": { - "title": "EntityReference", - "description": "The project, the evaluation is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "self": { "description": "The location of this entity.", @@ -6657,14 +6477,7 @@ "type": "string" }, "error": { - "title": "EntityError", - "description": "The details of the error in case the entity is in a failed state.", - "allOf": [ - { - "$ref": "#/definitions/EntityError" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityError" } } }, @@ -6673,13 +6486,7 @@ "type": "object", "properties": { "project": { - "title": "EntityReference", - "description": "The project, the entity is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "displayName": { "description": "The name of the object.", @@ -6723,14 +6530,7 @@ } }, "links": { - "title": "FileLinks", - "description": "The links for additional actions or content related to this file.", - "allOf": [ - { - "$ref": "#/definitions/FileLinks" - } - ], - "readOnly": true + "$ref": "#/definitions/FileLinks" }, "createdDateTime": { "format": "date-time", @@ -6739,14 +6539,7 @@ "readOnly": true }, "properties": { - "title": "FileProperties", - "description": "Additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/FileProperties" - } - ], - "readOnly": true + "$ref": "#/definitions/FileProperties" }, "name": { "description": "The name of this file.", @@ -6885,13 +6678,7 @@ "type": "string" }, "innerError": { - "title": "InnerError", - "description": "Finer error details.", - "allOf": [ - { - "$ref": "#/definitions/InnerError" - } - ] + "$ref": "#/definitions/InnerError" } } }, @@ -6915,32 +6702,13 @@ "type": "object", "properties": { "project": { - "title": "EntityReference", - "description": "The project, the model is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "links": { - "title": "ModelLinks", - "description": "The links for additional actions or content related to this model.", - "allOf": [ - { - "$ref": "#/definitions/ModelLinks" - } - ], - "readOnly": true + "$ref": "#/definitions/ModelLinks" }, "properties": { - "title": "ModelProperties", - "description": "Additional configuration options when creating a new model and additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/ModelProperties" - } - ] + "$ref": "#/definitions/ModelProperties" }, "self": { "description": "The location of this entity.", @@ -6960,13 +6728,7 @@ "type": "string" }, "baseModel": { - "title": "EntityReference", - "description": "The base model used for adaptation.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "datasets": { "description": "Datasets used for adaptation.", @@ -7086,13 +6848,7 @@ "type": "object", "properties": { "model": { - "title": "EntityReference", - "description": "The model, the endpoint is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "modelFiles": { "description": "The model files, the endpoint requires.", @@ -7116,28 +6872,14 @@ "type": "object", "properties": { "deprecationDates": { - "title": "ModelDeprecationDates", - "description": "The date when features of this model become deprecated.", - "allOf": [ - { - "$ref": "#/definitions/ModelDeprecationDates" - } - ], - "readOnly": true + "$ref": "#/definitions/ModelDeprecationDates" }, "email": { "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", "type": "string" }, "error": { - "title": "EntityError", - "description": "The details of the error in case the entity is in a failed state.", - "allOf": [ - { - "$ref": "#/definitions/EntityError" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityError" } } }, @@ -7146,13 +6888,7 @@ "type": "object", "properties": { "project": { - "title": "EntityReference", - "description": "The project, the entity is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "displayName": { "description": "The name of the object.", @@ -7332,24 +7068,10 @@ "type": "object", "properties": { "links": { - "title": "ProjectLinks", - "description": "The links for additional actions or content related to this project.", - "allOf": [ - { - "$ref": "#/definitions/ProjectLinks" - } - ], - "readOnly": true + "$ref": "#/definitions/ProjectLinks" }, "properties": { - "title": "ProjectProperties", - "description": "Additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/ProjectProperties" - } - ], - "readOnly": true + "$ref": "#/definitions/ProjectProperties" }, "self": { "description": "The location of this entity.", @@ -7513,23 +7235,10 @@ "type": "object", "properties": { "links": { - "title": "Links", - "description": "The links for additional actions or content related to this transcription.", - "allOf": [ - { - "$ref": "#/definitions/Links" - } - ], - "readOnly": true + "$ref": "#/definitions/Links" }, "properties": { - "title": "TranscriptionProperties", - "description": "Additional configuration options when creating a new transcription and additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/TranscriptionProperties" - } - ] + "$ref": "#/definitions/TranscriptionProperties" }, "self": { "description": "The location of this entity.", @@ -7537,31 +7246,13 @@ "readOnly": true }, "model": { - "title": "EntityReference", - "description": "The model used in this transcription.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "project": { - "title": "EntityReference", - "description": "The project, the transcription is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "dataset": { - "title": "EntityReference", - "description": "A list of acoustic or audio files datasets containing the audio files that will be transcribed.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "contentUrls": { "description": "A list of content urls to get audio files from for transcription. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.", @@ -7690,14 +7381,7 @@ "type": "string" }, "error": { - "title": "EntityError", - "description": "The details of the error in case the entity is in a failed state.", - "allOf": [ - { - "$ref": "#/definitions/EntityError" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityError" } } }, @@ -7706,13 +7390,7 @@ "type": "object", "properties": { "project": { - "title": "EntityReference", - "description": "The project, the entity is associated with.", - "allOf": [ - { - "$ref": "#/definitions/EntityReference" - } - ] + "$ref": "#/definitions/EntityReference" }, "displayName": { "description": "The name of the object.", @@ -7741,23 +7419,10 @@ "type": "object", "properties": { "links": { - "title": "WebHookLinks", - "description": "The links for additional actions or content related to this webhook.", - "allOf": [ - { - "$ref": "#/definitions/WebHookLinks" - } - ], - "readOnly": true + "$ref": "#/definitions/WebHookLinks" }, "properties": { - "title": "WebHookProperties", - "description": "Additional configuration options when creating a new webhook\r\nand additional metadata provided by the service.", - "allOf": [ - { - "$ref": "#/definitions/WebHookProperties" - } - ] + "$ref": "#/definitions/WebHookProperties" }, "self": { "description": "The location of this entity.", @@ -7906,14 +7571,7 @@ "type": "object", "properties": { "error": { - "title": "EntityError", - "description": "The details of the error in case the dataset is in a failed state.", - "allOf": [ - { - "$ref": "#/definitions/EntityError" - } - ], - "readOnly": true + "$ref": "#/definitions/EntityError" }, "apiVersion": { "description": "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\r\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\r\nthe web hook will be disabled.", @@ -7945,13 +7603,7 @@ "type": "string" }, "properties": { - "title": "WebHookPropertiesUpdate", - "description": "Additional configuration options when updating a webhook.", - "allOf": [ - { - "$ref": "#/definitions/WebHookPropertiesUpdate" - } - ] + "$ref": "#/definitions/WebHookPropertiesUpdate" }, "events": { "title": "WebHookEvents", From 1704556d3a8f1ba4f3926e10a694e1f2f78554c9 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 08:11:37 +0100 Subject: [PATCH 20/34] adding examples --- .../v2.0/examples/create _transcription.json | 22 + .../v2.0/examples/create_accuracy_test.json | 23 + .../stable/v2.0/examples/create_endpoint.json | 20 + .../create_endpoint_data_exports.json | 12 + .../stable/v2.0/examples/create_model.json | 22 + .../v2.0/examples/get_accuracy_test.json | 99 + .../v2.0/examples/get_accuracy_tests.json | 101 + .../stable/v2.0/examples/get_dataset.json | 25 + .../stable/v2.0/examples/get_datasets.json | 55 + .../stable/v2.0/examples/get_endpoint.json | 91 + .../examples/get_endpoint_data_export.json | 20 + .../examples/get_endpoint_data_exports.json | 22 + .../stable/v2.0/examples/get_endpoints.json | 93 + .../stable/v2.0/examples/get_model.json | 48 + .../stable/v2.0/examples/get_models.json | 76 + .../get_supported_dataset_locales.json | 23 + .../get_supported_endpoint_locales.json | 15 + .../examples/get_supported_model_locales.json | 20 + .../get_supported_transcription_locales.json | 15 + .../v2.0/examples/get_transcription.json | 95 + .../v2.0/examples/get_transcriptions.json | 97 + .../v2.0/examples/update_accuracy_test.json | 104 + .../stable/v2.0/examples/update_dataset.json | 30 + .../stable/v2.0/examples/update_endpoint.json | 96 + .../stable/v2.0/examples/update_model.json | 53 + .../v2.0/examples/update_transcription.json | 100 + .../stable/v2.0/examples/upload_dataset.json | 17 + .../stable/v2.0/speechtotext.json | 1141 +++++++- .../stable/v3.0/examples/copy_model.json | 42 + .../v3.0/examples/create _transcription.json | 58 + .../stable/v3.0/examples/create_dataset.json | 37 + .../stable/v3.0/examples/create_endpoint.json | 48 + .../v3.0/examples/create_evaluation.json | 70 + .../stable/v3.0/examples/create_model.json | 54 + .../stable/v3.0/examples/create_project.json | 36 + .../stable/v3.0/examples/create_web_hook.json | 42 + .../stable/v3.0/examples/get_base_model.json | 28 + .../v3.0/examples/get_base_model_log.json | 23 + .../v3.0/examples/get_base_model_logs.json | 40 + .../examples/get_base_model_manifest.json | 51 + .../stable/v3.0/examples/get_base_models.json | 50 + .../stable/v3.0/examples/get_dataset.json | 29 + .../v3.0/examples/get_dataset_file.json | 23 + .../v3.0/examples/get_dataset_files.json | 40 + .../stable/v3.0/examples/get_datasets.json | 72 + .../stable/v3.0/examples/get_endpoint.json | 36 + .../v3.0/examples/get_endpoint_log.json | 23 + .../v3.0/examples/get_endpoint_logs.json | 40 + .../stable/v3.0/examples/get_endpoints.json | 91 + .../stable/v3.0/examples/get_evaluation.json | 55 + .../v3.0/examples/get_evaluation_file.json | 23 + .../v3.0/examples/get_evaluation_files.json | 40 + .../stable/v3.0/examples/get_evaluations.json | 148 + .../stable/v3.0/examples/get_model.json | 38 + .../v3.0/examples/get_model_manifest.json | 51 + .../stable/v3.0/examples/get_models.json | 70 + .../v3.0/examples/get_project_datasets.json | 72 + .../v3.0/examples/get_project_endpoints.json | 91 + .../examples/get_project_evaluations.json | 148 + .../v3.0/examples/get_project_models.json | 70 + .../examples/get_project_transcriptions.json | 48 + .../stable/v3.0/examples/get_projects.json | 31 + .../get_supported_dataset_locales.json | 23 + .../get_supported_endpoint_locales.json | 15 + .../get_supported_evaluations_locales.json | 15 + .../examples/get_supported_model_locales.json | 15 + .../get_supported_project_locales.json | 15 + .../get_supported_transcription_locales.json | 15 + .../v3.0/examples/get_transcription.json | 43 + .../v3.0/examples/get_transcription_file.json | 23 + .../examples/get_transcription_files.json | 40 + .../v3.0/examples/get_transcriptions.json | 48 + .../stable/v3.0/examples/get_web_hook.json | 30 + .../stable/v3.0/examples/get_web_hooks.json | 73 + .../stable/v3.0/examples/update_dataset.json | 33 + .../stable/v3.0/examples/update_endpoint.json | 49 + .../v3.0/examples/update_evaluation.json | 60 + .../stable/v3.0/examples/update_model.json | 46 + .../stable/v3.0/examples/update_project.json | 38 + .../v3.0/examples/update_transcription.json | 51 + .../stable/v3.0/examples/update_web hook.json | 48 + .../stable/v3.0/examples/upload_dataset.json | 40 + .../stable/v3.0/speechtotext.json | 2395 ++++++++++++++++- 83 files changed, 7225 insertions(+), 243 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json new file mode 100644 index 000000000000..4e6e918b53f9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "transcription": { + "recordingsUrl": "https://contoso.com/mystoragelocation", + "models": [], + "locale": "en-US", + "name": "Transcription using locale en-US", + "description": "An optional description of the transcription.", + "properties": { + "AddWordLevelTimestamps": "True", + "AddDiarization": "True", + "AddSentiment": "True", + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic" + } + } + }, + "responses": {} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json new file mode 100644 index 000000000000..70960ec1cbca --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "testDefinition": { + "models": [ + { + "id": "685b5e3a-e5c0-45ae-8c8a-86b50cabd3ea" + }, + { + "id": "15fde948-c8b7-4484-a610-07d4ddc69fad" + } + ], + "dataset": { + "id": "5d2b9da6-e687-47b3-bb71-140a4d1ca3d5" + }, + "name": "Accuracy test", + "description": "This is an accuracy test" + } + }, + "responses": {} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json new file mode 100644 index 000000000000..e3034a6911a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "endpointDefinition": { + "models": [ + { + "id": "d7295e5c-089f-44ab-99b0-73c17ffc3ae0" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "locale": "en-US", + "name": "Speech endpoint definition", + "description": "This is a speech endpoint" + } + }, + "responses": {} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json new file mode 100644 index 000000000000..14d1f8ab789e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "endpointDataDefinition": { + "startDate": "2018-12-08T00:00:00Z", + "endDate": "2019-01-07T00:00:00Z" + } + }, + "responses": {} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json new file mode 100644 index 000000000000..33666a264d69 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "modelDefinition": { + "modelKind": "Language", + "baseModel": { + "id": "f2842de0-fc16-4858-8391-e3fd1efb6980" + }, + "datasets": [ + { + "id": "a712c3ba-0e49-4059-a17f-0465426514c7" + } + ], + "locale": "en-US", + "name": "Language model", + "description": "This is a language model definition" + } + }, + "responses": {} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json new file mode 100644 index 000000000000..813bb718490c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "name": "Accuracy test" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json new file mode 100644 index 000000000000..8cbfad25e6a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "name": "Accuracy test" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json new file mode 100644 index 000000000000..059b639a9121 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json new file mode 100644 index 000000000000..bf63aed82633 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + { + "dataImportKind": "Pronunciation", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "c0a2c730-19f7-4a78-9e0f-f8b6efa5f0a5", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Pronunciation dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/PronunciationData/71e831ef-ba18-4fbb-8559-cea56f98284f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=5b69ed9e-e848-461b-8f4e-78851bc82f07" + } + }, + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json new file mode 100644 index 000000000000..8cc107c07221 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "8fa0669c-a01e-4693-ae3a-93baf40f26d9", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json new file mode 100644 index 000000000000..bfa144681f92 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "startDate": "2018-12-08T00:00:00Z", + "endDate": "2019-01-07T00:00:00Z", + "dataUrl": "https://contoso.com/", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json new file mode 100644 index 000000000000..1acad5c3844b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "startDate": "2018-12-08T00:00:00Z", + "endDate": "2019-01-07T00:00:00Z", + "dataUrl": "https://contoso.com/", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json new file mode 100644 index 000000000000..5f7f8e87f613 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "8fa0669c-a01e-4693-ae3a-93baf40f26d9", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json new file mode 100644 index 000000000000..7ca1bd3b7137 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json new file mode 100644 index 000000000000..b61f367fe96d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + }, + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..827c8852d7ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Acoustic": [ + "en-US" + ], + "Language": [ + "en-US", + "de-DE" + ], + "Pronunciation": [ + "en-US" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..ad0adf228928 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..59eedb5955ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Acoustic": [ + "en-US" + ], + "Language": [ + "en-US", + "de-DE" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..ad0adf228928 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json new file mode 100644 index 000000000000..6218cf89fe7e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "recordingsUrl": "https://contoso.com/", + "reportFileUrl": "https://contoso.com/", + "resultsUrls": { + "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", + "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9891c965-bb32-4880-b14b-6d44efb158f3", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json new file mode 100644 index 000000000000..968a6f1aabf7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "recordingsUrl": "https://contoso.com/", + "reportFileUrl": "https://contoso.com/", + "resultsUrls": { + "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", + "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9891c965-bb32-4880-b14b-6d44efb158f3", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json new file mode 100644 index 000000000000..7f7afa880b90 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "testUpdate": { + "name": "Updated test name", + "description": "Updated test description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "dataset": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + }, + "wordErrorRate": 0.0, + "resultsUrl": "https://contoso.com/results/9E32D75F-CEE1-47F5-BA32-65E9BBA18743", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", + "createdDateTime": "2019-01-07T12:34:12Z", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "name": "Accuracy test" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json new file mode 100644 index 000000000000..e63c3cf4b56d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "datasetUpdate": { + "name": "Updated dataset name", + "description": "Updated dataset description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json new file mode 100644 index 000000000000..ac229dd7719b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "endpointUpdate": { + "name": "Updated speech endpoint", + "description": "Example for an updated speech endpoint" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointKind": "SpeechRecognition", + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "concurrentRecognitions": 1, + "contentLoggingEnabled": false, + "endpointUrls": { + "UniversalWebSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "8fa0669c-a01e-4693-ae3a-93baf40f26d9", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json new file mode 100644 index 000000000000..bf017e0c39c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "modelUpdate": { + "name": "Language model update", + "description": "This is a language model update" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json new file mode 100644 index 000000000000..2e1787e22dbe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "transcriptionUpdate": { + "name": "Updated transcription name", + "description": "Updated transcription description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "recordingsUrl": "https://contoso.com/", + "reportFileUrl": "https://contoso.com/", + "resultsUrls": { + "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", + "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9891c965-bb32-4880-b14b-6d44efb158f3", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json new file mode 100644 index 000000000000..58d21a38cde4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "multipart/form-data", + "form-data": { + "name": "My speech dataset name", + "description": "My speech dataset description", + "locale": "en-US", + "dataImportKind": "Acoustic", + "properties": { + "property": "true" + } + } + }, + "responses": {} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index ff0ddccae9e9..df35724fa866 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -9,18 +9,6 @@ }, "version": "v2.0" }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/speechtotext/v2.0", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, - "schemes": [ - "https" - ], "paths": { "/accuracytests": { "get": { @@ -61,6 +49,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -82,6 +76,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -103,6 +103,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -126,10 +132,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get all accuracy tests": { + "$ref": "./examples/get_accuracy_tests.json" + } + } }, "post": { "tags": [ @@ -160,6 +171,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -181,6 +198,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -202,6 +225,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -225,10 +254,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Create an accuracy test": { + "$ref": "./examples/create_accuracy_test.json" + } + } } }, "/accuracytests/{id}": { @@ -281,6 +315,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -302,6 +342,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -323,6 +369,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -344,6 +396,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -367,10 +425,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get an accuracy test": { + "$ref": "./examples/get_accuracy_test.json" + } + } }, "patch": { "tags": [ @@ -429,6 +492,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -450,6 +519,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -471,6 +546,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -492,6 +573,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -513,6 +600,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -536,10 +629,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Update an accuracy test": { + "$ref": "./examples/update_accuracy_test.json" + } + } }, "delete": { "tags": [ @@ -583,6 +681,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -604,6 +708,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -625,6 +735,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -648,8 +764,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -690,6 +806,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -711,6 +833,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -732,6 +860,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -755,10 +889,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_dataset_locales.json" + } + } } }, "/datasets": { @@ -800,6 +939,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -821,6 +966,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -842,6 +993,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -865,10 +1022,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get all datasets": { + "$ref": "./examples/get_datasets.json" + } + } } }, "/datasets/{id}": { @@ -921,6 +1083,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -942,6 +1110,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -963,6 +1137,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -984,6 +1164,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1007,10 +1193,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a dataset": { + "$ref": "./examples/get_dataset.json" + } + } }, "patch": { "tags": [ @@ -1069,6 +1260,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1090,6 +1287,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1111,6 +1314,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1132,6 +1341,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1153,6 +1368,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1176,10 +1397,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a dataset": { + "$ref": "./examples/update_dataset.json" + } + } }, "delete": { "tags": [ @@ -1223,6 +1449,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1244,6 +1476,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1265,6 +1503,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1286,6 +1530,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1309,8 +1559,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -1415,6 +1665,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1436,6 +1692,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1457,6 +1719,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1478,6 +1746,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1499,6 +1773,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1522,13 +1802,18 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" + }, + "x-ms-example": { + "Upload a dataset": { + "$ref": "./examples/upload_dataset.json" + } } } }, @@ -1571,6 +1856,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1592,6 +1883,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1613,6 +1910,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1636,10 +1939,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_endpoint_locales.json" + } + } } }, "/endpoints": { @@ -1681,6 +1989,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1702,6 +2016,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1723,6 +2043,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1746,10 +2072,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + } + } }, "post": { "tags": [ @@ -1811,6 +2142,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1832,6 +2169,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1853,6 +2196,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1874,6 +2223,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1897,13 +2252,18 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" + }, + "x-ms-example": { + "Create an endpoint": { + "$ref": "./examples/create_endpoint.json" + } } } }, @@ -1957,6 +2317,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1978,6 +2344,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1999,6 +2371,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2020,6 +2398,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2043,10 +2427,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get an endpoint": { + "$ref": "./examples/get_endpoint.json" + } + } }, "delete": { "tags": [ @@ -2090,6 +2479,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2111,6 +2506,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2132,6 +2533,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2155,8 +2562,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2217,6 +2624,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2238,6 +2651,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2259,6 +2678,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2280,6 +2705,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2301,6 +2732,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2324,10 +2761,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Update an endpoint": { + "$ref": "./examples/update_endpoint.json" + } + } } }, "/endpoints/{endpointId}/data": { @@ -2374,6 +2816,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2395,6 +2843,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2416,6 +2870,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2439,8 +2899,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2492,6 +2952,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2513,6 +2979,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2534,6 +3006,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2555,6 +3033,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2578,10 +3062,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get all endpoint data exports": { + "$ref": "./examples/get_endpoint_data_exports.json" + } + } }, "post": { "tags": [ @@ -2654,6 +3143,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2675,6 +3170,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2696,6 +3197,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2717,6 +3224,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2738,6 +3251,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2761,13 +3280,18 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" + }, + "x-ms-example": { + "Create an endpoint data exports": { + "$ref": "./examples/create_endpoint_data_exports.json" + } } } }, @@ -2822,6 +3346,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2843,6 +3373,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2864,6 +3400,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2885,6 +3427,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2908,8 +3456,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] }, @@ -2966,6 +3514,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2987,6 +3541,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3008,6 +3568,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3029,6 +3595,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3052,10 +3624,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get an endpoint data export": { + "$ref": "./examples/get_endpoint_data_export.json" + } + } } }, "/models/locales": { @@ -3094,6 +3671,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3115,6 +3698,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3136,6 +3725,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3159,10 +3754,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_model_locales.json" + } + } } }, "/models": { @@ -3204,6 +3804,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3225,6 +3831,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3246,6 +3858,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3269,10 +3887,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get all models": { + "$ref": "./examples/get_models.json" + } + } }, "post": { "tags": [ @@ -3334,6 +3957,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3355,6 +3984,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3376,6 +4011,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3397,6 +4038,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3420,13 +4067,18 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" + }, + "x-ms-example": { + "Create a model": { + "$ref": "./examples/create_model.json" + } } } }, @@ -3480,6 +4132,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3501,6 +4159,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3522,6 +4186,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3543,6 +4213,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3566,10 +4242,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a model": { + "$ref": "./examples/get_model.json" + } + } }, "patch": { "tags": [ @@ -3628,6 +4309,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3649,6 +4336,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3670,6 +4363,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3691,6 +4390,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3712,6 +4417,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3735,10 +4446,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a model": { + "$ref": "./examples/update_model.json" + } + } }, "delete": { "tags": [ @@ -3782,6 +4498,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3803,6 +4525,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3824,6 +4552,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3845,6 +4579,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3868,8 +4608,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -3913,6 +4653,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3934,6 +4680,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3955,6 +4707,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3978,10 +4736,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_transcription_locales.json" + } + } } }, "/transcriptions": { @@ -4039,6 +4802,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4060,6 +4829,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4081,6 +4856,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4104,10 +4885,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + } + } }, "post": { "tags": [ @@ -4169,6 +4955,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4190,6 +4982,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4211,6 +5009,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4232,6 +5036,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4255,13 +5065,18 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ], "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" + }, + "x-ms-example": { + "Create a transcription": { + "$ref": "./examples/create _transcription.json" + } } } }, @@ -4315,6 +5130,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4336,6 +5157,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4357,6 +5184,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4378,6 +5211,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4401,10 +5240,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a transcription": { + "$ref": "./examples/get_transcription.json" + } + } }, "patch": { "tags": [ @@ -4463,6 +5307,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4484,6 +5334,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4505,6 +5361,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4526,6 +5388,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4547,6 +5415,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4570,10 +5444,15 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } }, "delete": { "tags": [ @@ -4620,6 +5499,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4641,6 +5526,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4662,6 +5553,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4683,6 +5580,12 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4706,8 +5609,8 @@ }, "security": [ { - "subscription_key": [], - "token": [] + "subscription_key": [ ], + "token": [ ] } ] } @@ -5638,17 +6541,6 @@ } } }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - } - }, "securityDefinitions": { "subscription_key": { "type": "apiKey", @@ -5662,5 +6554,28 @@ "in": "header", "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" } + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/speechtotext/v2.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json new file mode 100644 index 000000000000..c4f63e185eed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "modelCopy": { + "targetSubscriptionKey": "KeyForTheSubscriptionTheModelIsSupposedToBeCopiedTo" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json new file mode 100644 index 000000000000..47416f14a3aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation", + "https://contoso.com/myotherstoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked" + }, + "locale": "en-US", + "displayName": "Transcription using default model for en-US" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json new file mode 100644 index 000000000000..c33e768517a0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "dataset": { + "kind": "Acoustic", + "contentUrl": "https://contoso.com/location", + "locale": "en-US", + "displayName": "My speech dataset name", + "description": "My speech dataset description" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "kind": "Acoustic", + "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json new file mode 100644 index 000000000000..7dc365548b28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "endpoint": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "properties": { + "loggingEnabled": true + }, + "locale": "en-US", + "displayName": "Speech endpoint definition", + "description": "This is a speech endpoint" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json new file mode 100644 index 000000000000..00e06837f8b2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "evaluation": { + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "locale": "en-US", + "displayName": "My new evaluation", + "description": "The description of the evaluation" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json new file mode 100644 index 000000000000..1c4274fe469c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json new file mode 100644 index 000000000000..5d357eb66ff0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "project": { + "locale": "en-US", + "displayName": "My speech project" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json new file mode 100644 index 000000000000..f9179393ec7b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "webHook": { + "displayName": "TranscriptionCompletionWebHook", + "properties": { + "secret": "SecretUsedToCreateHMACHexDigestThatYouWillFindIn\"X-MicrosoftSpeechServices-Signature\"HeaderWhenBeingCalledBack" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription." + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/hooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/hooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "NotStarted" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json new file mode 100644 index 000000000000..b3e6354cfc7d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json new file mode 100644 index 000000000000..1b369e11ebaf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json new file mode 100644 index 000000000000..466e6e31d3a5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/base/en-us/files/logs?top=2&SkipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json new file mode 100644 index 000000000000..267cd6d1ab16 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/02231df2-012f-45d4-9af0-8a3e4ccc877c" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=wgSFvL8ParcZsckXWbr%2BSYYdPXHr2srdevD%2FoX4Ay7g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=D7Ql1riMUbmaFSX7DpuOitS4mZTOIbJPoB1qfVEP8DY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=Hf%2B50Pxox02NMdxmlcDZEDMWhUEz8nHE0L0aAkiDnWY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=pTv1hsjG111Nwl%2FGdwZbNfXDIfx5EBIzkTO6OksSC9g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=RS5wj8nw7cCMp3IrBVPdH6fLBznfuk%2FH%2BcuUQ8DfSh0%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=yqsHvDR9nLn3lyFFbi9U%2BxbRwWsfWD0qoSiri3buLkA%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json new file mode 100644 index 000000000000..7c17a85a6549 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/1327b659-83b2-42b5-afd8-184d1e2a1a2e", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/1327b659-83b2-42b5-afd8-184d1e2a1a2e" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "de-DE", + "displayName": "de-DE Base model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=2&top=2" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json new file mode 100644 index 000000000000..c9956950e891 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "kind": "Acoustic", + "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json new file mode 100644 index 000000000000..854c95397562 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json new file mode 100644 index 000000000000..7e57631c88bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/f035cf2d-4051-4131-85e7-97e3a7349c86", + "name": "Name", + "kind": "LanguageData", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/db2cb8bf-717a-4f41-b337-a6bc29a18549/files?skip=2&top=2" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json new file mode 100644 index 000000000000..6b470bb086f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "kind": "Acoustic", + "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", + "kind": "Language", + "contentUrl": "https://www.example.org/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b", + "kind": "Pronunciation", + "contentUrl": "https://www.example.org/PronunciationData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT10M" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Pronunciation dataset", + "customProperties": { + "CustomProperty": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets?skip=3&top=3" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json new file mode 100644 index 000000000000..8a512190dbc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json new file mode 100644 index 000000000000..1b369e11ebaf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json new file mode 100644 index 000000000000..c9b6b094fea9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&SkipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json new file mode 100644 index 000000000000..fdca1d2edc80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=3&top=3" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json new file mode 100644 index 000000000000..37ca30bd2364 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json new file mode 100644 index 000000000000..e8f5908f73aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/33c0c641-acb0-41f7-b87d-2783e8b9c2b1", + "name": "Name", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json new file mode 100644 index 000000000000..8b419336f489 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a", + "name": "Name", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model1_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/33c0c641-acb0-41f7-b87d-2783e8b9c2b1", + "name": "Name", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json new file mode 100644 index 000000000000..bc067323ae24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/bfb375ef-5e20-4f71-8e0c-00fa21ba6477", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=3&top=3" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json new file mode 100644 index 000000000000..f86d09d260e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json new file mode 100644 index 000000000000..267cd6d1ab16 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/02231df2-012f-45d4-9af0-8a3e4ccc877c" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=wgSFvL8ParcZsckXWbr%2BSYYdPXHr2srdevD%2FoX4Ay7g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=D7Ql1riMUbmaFSX7DpuOitS4mZTOIbJPoB1qfVEP8DY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=Hf%2B50Pxox02NMdxmlcDZEDMWhUEz8nHE0L0aAkiDnWY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=pTv1hsjG111Nwl%2FGdwZbNfXDIfx5EBIzkTO6OksSC9g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=RS5wj8nw7cCMp3IrBVPdH6fLBznfuk%2FH%2BcuUQ8DfSh0%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=yqsHvDR9nLn3lyFFbi9U%2BxbRwWsfWD0qoSiri3buLkA%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json new file mode 100644 index 000000000000..b127def5f50f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=2&top=2" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json new file mode 100644 index 000000000000..6b470bb086f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "kind": "Acoustic", + "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", + "kind": "Language", + "contentUrl": "https://www.example.org/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b", + "kind": "Pronunciation", + "contentUrl": "https://www.example.org/PronunciationData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT10M" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Pronunciation dataset", + "customProperties": { + "CustomProperty": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets?skip=3&top=3" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json new file mode 100644 index 000000000000..fdca1d2edc80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=3&top=3" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json new file mode 100644 index 000000000000..bc067323ae24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/bfb375ef-5e20-4f71-8e0c-00fa21ba6477", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=3&top=3" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json new file mode 100644 index 000000000000..b127def5f50f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=2&top=2" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json new file mode 100644 index 000000000000..b236667a561d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=100&top=100" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json new file mode 100644 index 000000000000..29a62e29cb03 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..26de58b0f9b4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "en-US": [ + "Acoustic", + "Pronunciation", + "AudioFiles" + ], + "de-DE": [ + "Acoustic", + "Language", + "AudioFiles" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..ad0adf228928 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json new file mode 100644 index 000000000000..ad0adf228928 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..ad0adf228928 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json new file mode 100644 index 000000000000..ad0adf228928 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..ad0adf228928 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json new file mode 100644 index 000000000000..998137d62eeb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json new file mode 100644 index 000000000000..854c95397562 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json new file mode 100644 index 000000000000..7e57631c88bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "Name", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/f035cf2d-4051-4131-85e7-97e3a7349c86", + "name": "Name", + "kind": "LanguageData", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/db2cb8bf-717a-4f41-b337-a6bc29a18549/files?skip=2&top=2" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json new file mode 100644 index 000000000000..b236667a561d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=100&top=100" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json new file mode 100644 index 000000000000..52fd2a6bc130 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json new file mode 100644 index 000000000000..63f514673cfa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/034034ec-2872-43e0-b1e5-f57735e253bf", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks?skip=3&top=3" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json new file mode 100644 index 000000000000..f28c01a5c73a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "datasetUpdate": { + "displayName": "Updated dataset name", + "description": "Updated dataset description", + "customProperties": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json new file mode 100644 index 000000000000..00294c534707 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "endpointUpdate": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "properties": { + "contentLoggingEnabled": true + }, + "displayName": "Updated endpoint with new model", + "customProperties": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json new file mode 100644 index 000000000000..88b14a6e6749 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "evaluationUpdate": { + "displayName": "Updated evaluation", + "description": "Updated evaluation description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate2": 0.065, + "wordErrorRate1": 0.065, + "sentenceErrorRate2": 0.375, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "sentenceErrorRate1": 0.375, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0 + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json new file mode 100644 index 000000000000..47b9aeb1b035 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "modelUpdate": { + "displayName": "Language model update", + "description": "This is a language model update", + "customProperties": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T01:00:00Z", + "transcriptionDateTime": "2023-05-04T02:00:00Z" + } + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json new file mode 100644 index 000000000000..7ef76118d7cf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "projectUpdate": { + "displayName": "My updated speech project", + "customProperties": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json new file mode 100644 index 000000000000..fd5590efcd3c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "transcriptionUpdate": { + "displayName": "Updated transcription name", + "description": "Updated transcription description", + "customProperties": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json new file mode 100644 index 000000000000..2587d8f311e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "application/json", + "webHookUpdate": { + "properties": { + "secret": "SecretUsedToCreateHMACHexDigestThatYouWillFindIn\"X-MicrosoftSpeechServices-Signature\"HeaderWhenBeingCalledBack" + }, + "events": { + "evaluationCreation": true, + "evaluationProcessing": true, + "evaluationCompletion": true, + "evaluationDeletion": true + }, + "webUrl": "https://contoso.com/call/me/back", + "displayName": "TranscriptionCompletionWebHook", + "description": "I registered this URL to get a POST request for each completed transcription.", + "customProperties": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + }, + "properties": { + "apiVersion": "v3.0" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json new file mode 100644 index 000000000000..7757b9cc6999 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "multipart/form-data", + "form-data": { + "displayName": "My speech dataset name", + "description": "My speech dataset description", + "locale": "en-US", + "kind": "Acoustic", + "customProperties": { + "customProperty": "true" + }, + "email": "dataset@contoso.com" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "kind": "Acoustic", + "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index d31cb3cd1702..74aab99a230d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -9,18 +9,6 @@ }, "version": "v3.0" }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/speechtotext/v3.0", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, - "schemes": [ - "https" - ], "paths": { "/datasets/locales": { "get": { @@ -44,6 +32,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -51,6 +45,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -58,6 +58,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -70,9 +76,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_dataset_locales.json" + } + } } }, "/datasets": { @@ -119,6 +130,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -126,6 +147,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -133,6 +160,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -140,6 +173,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -152,12 +191,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all datasets": { + "$ref": "./examples/get_datasets.json" + } } }, "post": { @@ -202,6 +246,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -209,6 +263,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -216,6 +276,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -223,6 +289,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -235,9 +307,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Create a dataset": { + "$ref": "./examples/create_dataset.json" + } + } } }, "/datasets/{id}": { @@ -278,6 +355,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -285,6 +372,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -292,6 +385,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -299,6 +398,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -306,6 +411,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -318,9 +429,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a dataset": { + "$ref": "./examples/get_dataset.json" + } + } }, "patch": { "tags": [ @@ -372,6 +488,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -379,6 +505,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -386,6 +518,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "409": { @@ -393,6 +531,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -400,6 +544,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -412,9 +562,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a dataset": { + "$ref": "./examples/update_dataset.json" + } + } }, "delete": { "tags": [ @@ -444,6 +599,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -451,6 +616,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -458,6 +629,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -472,6 +649,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -484,7 +667,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -574,6 +757,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -581,6 +774,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -588,6 +787,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "415": { @@ -595,6 +800,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -602,6 +813,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -615,9 +832,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Upload a dataset": { + "$ref": "./examples/upload_dataset.json" + } + } } }, "/datasets/{id}/files": { @@ -686,6 +908,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -693,6 +921,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -700,6 +934,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -707,6 +947,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -719,12 +965,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all files": { + "$ref": "./examples/get_dataset_files.json" + } } } }, @@ -782,6 +1033,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -789,6 +1046,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -796,6 +1059,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -803,6 +1072,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -815,9 +1090,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a file": { + "$ref": "./examples/get_dataset_file.json" + } + } } }, "/endpoints/locales": { @@ -845,6 +1125,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -852,6 +1138,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -859,6 +1151,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -871,9 +1169,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_endpoint_locales.json" + } + } } }, "/endpoints": { @@ -927,6 +1230,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -934,6 +1243,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -941,6 +1256,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -953,12 +1274,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + } } }, "post": { @@ -1003,6 +1329,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1010,6 +1346,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1017,6 +1359,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -1024,6 +1372,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1036,9 +1390,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Create an endpoint": { + "$ref": "./examples/create_endpoint.json" + } + } } }, "/endpoints/{id}": { @@ -1086,6 +1445,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1093,6 +1458,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1100,6 +1471,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1107,6 +1484,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1119,9 +1502,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get an endpoint": { + "$ref": "./examples/get_endpoint.json" + } + } }, "delete": { "tags": [ @@ -1151,6 +1539,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1158,6 +1556,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1165,6 +1569,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1172,6 +1582,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1179,6 +1595,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1191,7 +1613,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] }, @@ -1245,6 +1667,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1252,6 +1684,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1259,6 +1697,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "409": { @@ -1266,6 +1710,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1273,6 +1723,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1285,9 +1741,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Update an endpoint": { + "$ref": "./examples/update_endpoint.json" + } + } } }, "/endpoints/{id}/files/logs": { @@ -1348,6 +1809,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1355,6 +1826,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1362,6 +1839,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1369,6 +1852,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1376,6 +1865,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1388,12 +1883,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all endpoint logs": { + "$ref": "./examples/get_endpoint_logs.json" + } } }, "delete": { @@ -1431,6 +1931,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1438,6 +1948,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1445,6 +1961,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1452,6 +1974,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1459,6 +1987,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1471,7 +2005,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -1522,6 +2056,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1529,6 +2073,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1536,6 +2086,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1543,6 +2099,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1550,6 +2112,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1562,9 +2130,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get an endpoint log": { + "$ref": "./examples/get_endpoint_log.json" + } + } }, "delete": { "tags": [ @@ -1601,6 +2174,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1608,6 +2191,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1615,6 +2204,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1622,6 +2217,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1629,6 +2230,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1641,7 +2248,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -1697,6 +2304,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1704,6 +2321,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1711,6 +2334,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1718,6 +2347,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1725,6 +2360,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1737,12 +2378,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all base model logs": { + "$ref": "./examples/get_base_model_logs.json" + } } }, "delete": { @@ -1779,6 +2425,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1786,6 +2442,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1793,6 +2455,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1800,6 +2468,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1807,6 +2481,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1819,7 +2499,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -1869,6 +2549,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1876,6 +2566,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1883,6 +2579,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1890,13 +2592,25 @@ "schema": { "$ref": "#/definitions/Error" }, - "x-ms-error-response": true + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "x-ms-error-response": true }, "429": { "description": "In case the rate limit has been exceeded.", "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1909,9 +2623,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a base model log": { + "$ref": "./examples/get_base_model_log.json" + } + } }, "delete": { "tags": [ @@ -1947,6 +2666,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -1954,6 +2683,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -1961,6 +2696,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -1968,6 +2709,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -1975,6 +2722,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1987,7 +2740,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -2017,6 +2770,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2024,6 +2783,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -2031,6 +2796,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2043,9 +2814,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_evaluations_locales.json" + } + } } }, "/evaluations": { @@ -2099,6 +2875,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2106,6 +2888,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -2113,6 +2901,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2125,12 +2919,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all evaluations": { + "$ref": "./examples/get_evaluations.json" + } } }, "post": { @@ -2182,6 +2981,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2189,6 +2994,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -2196,6 +3007,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2208,9 +3025,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Create a evaluation": { + "$ref": "./examples/create_evaluation.json" + } + } } }, "/evaluations/{id}/files": { @@ -2279,6 +3101,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2286,6 +3114,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -2293,6 +3127,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -2300,6 +3140,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2312,12 +3158,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all files": { + "$ref": "./examples/get_evaluation_files.json" + } } } }, @@ -2375,6 +3226,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2382,6 +3239,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -2389,6 +3252,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -2396,6 +3265,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2408,9 +3283,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a file": { + "$ref": "./examples/get_evaluation_file.json" + } + } } }, "/evaluations/{id}": { @@ -2458,6 +3338,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2465,6 +3351,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -2472,6 +3364,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -2479,6 +3377,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2491,9 +3395,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a evaluation": { + "$ref": "./examples/get_evaluation.json" + } + } }, "patch": { "tags": [ @@ -2545,6 +3454,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -2552,6 +3471,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2559,6 +3484,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "409": { @@ -2566,6 +3497,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -2573,6 +3510,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2585,9 +3528,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a evaluation": { + "$ref": "./examples/update_evaluation.json" + } + } }, "delete": { "tags": [ @@ -2617,6 +3565,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -2624,6 +3582,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2631,6 +3595,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -2645,6 +3615,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2657,7 +3633,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -2687,6 +3663,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2694,6 +3676,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -2701,6 +3689,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2713,9 +3707,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_model_locales.json" + } + } } }, "/models": { @@ -2769,6 +3768,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2776,6 +3781,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -2783,6 +3794,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2795,12 +3812,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all models": { + "$ref": "./examples/get_models.json" + } } }, "post": { @@ -2845,6 +3867,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -2852,6 +3884,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2859,6 +3897,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -2866,6 +3910,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2878,9 +3928,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Create a model": { + "$ref": "./examples/create_model.json" + } + } } }, "/models/base": { @@ -2928,6 +3983,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -2935,6 +3996,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -2942,6 +4009,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2954,12 +4027,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all base models": { + "$ref": "./examples/get_base_models.json" + } } } }, @@ -3008,6 +4086,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3015,6 +4099,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3022,6 +4112,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3029,6 +4125,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3041,9 +4143,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a model": { + "$ref": "./examples/get_model.json" + } + } }, "patch": { "tags": [ @@ -3095,6 +4202,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3102,6 +4219,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3109,6 +4232,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "409": { @@ -3116,6 +4245,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3123,6 +4258,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3135,9 +4276,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a model": { + "$ref": "./examples/update_model.json" + } + } }, "delete": { "tags": [ @@ -3167,6 +4313,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3174,6 +4330,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3181,6 +4343,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3195,6 +4363,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3207,7 +4381,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -3251,6 +4425,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3258,6 +4438,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3265,6 +4451,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3272,6 +4464,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3284,9 +4482,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a base model": { + "$ref": "./examples/get_base_model.json" + } + } } }, "/models/{id}/copyto": { @@ -3341,6 +4544,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3348,6 +4561,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3355,6 +4574,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3362,6 +4587,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3369,6 +4600,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3381,9 +4618,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Copy a model": { + "$ref": "./examples/copy_model.json" + } + } } }, "/models/{id}/manifest": { @@ -3425,6 +4667,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3432,6 +4684,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3439,6 +4697,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3446,6 +4710,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3453,6 +4723,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3465,9 +4741,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a model manifest": { + "$ref": "./examples/get_model_manifest.json" + } + } } }, "/models/base/{id}/manifest": { @@ -3509,6 +4790,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3516,6 +4807,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3523,6 +4820,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3530,6 +4833,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3537,6 +4846,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3549,9 +4864,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a base model manifest": { + "$ref": "./examples/get_base_model_manifest.json" + } + } } }, "/projects/locales": { @@ -3579,6 +4899,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3586,6 +4912,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -3593,6 +4925,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3605,9 +4943,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_project_locales.json" + } + } } }, "/projects": { @@ -3655,6 +4998,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3662,6 +5011,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -3669,6 +5024,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3681,12 +5042,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all projects": { + "$ref": "./examples/get_projects.json" + } } }, "post": { @@ -3728,6 +5094,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3735,6 +5111,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3742,6 +5124,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -3749,6 +5137,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3761,9 +5155,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Create a project": { + "$ref": "./examples/create_project.json" + } + } } }, "/projects/{id}": { @@ -3805,6 +5204,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3812,6 +5217,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3819,6 +5230,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3826,6 +5243,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3838,9 +5261,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get all projects": { + "$ref": "./examples/get_projects.json" + } + } }, "patch": { "tags": [ @@ -3886,6 +5314,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3893,6 +5331,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3900,6 +5344,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "409": { @@ -3907,6 +5357,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -3914,6 +5370,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3926,9 +5388,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a project": { + "$ref": "./examples/update_project.json" + } + } }, "delete": { "tags": [ @@ -3958,6 +5425,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -3965,6 +5442,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -3972,6 +5455,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -3986,6 +5475,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3998,7 +5493,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -4055,6 +5550,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4062,6 +5567,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4069,6 +5580,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -4076,6 +5593,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -4083,6 +5606,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4095,12 +5624,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all evaluations": { + "$ref": "./examples/get_project_evaluations.json" + } } } }, @@ -4156,6 +5690,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4163,6 +5707,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4170,6 +5720,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -4177,6 +5733,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -4184,6 +5746,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4196,12 +5764,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all datasets": { + "$ref": "./examples/get_project_datasets.json" + } } } }, @@ -4257,6 +5830,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4264,6 +5847,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4271,6 +5860,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -4278,6 +5873,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -4285,6 +5886,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4297,12 +5904,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all endpoints": { + "$ref": "./examples/get_project_endpoints.json" + } } } }, @@ -4358,6 +5970,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4365,6 +5987,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4372,6 +6000,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -4379,6 +6013,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -4386,6 +6026,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4398,12 +6044,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all models": { + "$ref": "./examples/get_project_models.json" + } } } }, @@ -4459,6 +6110,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4466,6 +6127,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4473,6 +6140,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -4480,6 +6153,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -4487,6 +6166,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4499,12 +6184,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all transcriptions": { + "$ref": "./examples/get_project_transcriptions.json" + } } } }, @@ -4533,6 +6223,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4540,6 +6236,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -4547,6 +6249,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4559,9 +6267,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get the supported locales": { + "$ref": "./examples/get_supported_transcription_locales.json" + } + } } }, "/transcriptions": { @@ -4615,6 +6328,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4622,6 +6341,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -4629,6 +6354,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4641,12 +6372,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + } } }, "post": { @@ -4691,6 +6427,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4698,6 +6444,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4705,6 +6457,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -4712,6 +6470,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4724,9 +6488,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Create a transcription": { + "$ref": "./examples/create _transcription.json" + } + } } }, "/transcriptions/{id}": { @@ -4774,6 +6543,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4781,6 +6556,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -4788,6 +6569,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -4795,6 +6582,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4807,9 +6600,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a transcription": { + "$ref": "./examples/get_transcription.json" + } + } }, "patch": { "tags": [ @@ -4861,6 +6659,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4868,6 +6676,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4875,6 +6689,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "409": { @@ -4882,6 +6702,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -4889,6 +6715,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4901,9 +6733,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } }, "delete": { "tags": [ @@ -4933,6 +6770,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -4940,6 +6787,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -4947,6 +6800,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -4961,6 +6820,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4973,7 +6838,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -5044,6 +6909,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5051,6 +6922,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -5058,6 +6935,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -5065,6 +6948,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5077,12 +6966,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all files": { + "$ref": "./examples/get_transcription_files.json" + } } } }, @@ -5140,6 +7034,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5147,6 +7047,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -5154,6 +7060,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -5161,6 +7073,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5173,9 +7091,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a file": { + "$ref": "./examples/get_transcription_file.json" + } + } } }, "/webhooks": { @@ -5229,6 +7152,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5236,6 +7165,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -5243,6 +7178,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5255,12 +7196,17 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" + }, + "x-ms-example": { + "Get all web hooks": { + "$ref": "./examples/get_web_hooks.json" + } } }, "post": { @@ -5303,6 +7249,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -5310,6 +7266,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5317,6 +7279,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "429": { @@ -5324,6 +7292,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5336,9 +7310,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Create a web hook": { + "$ref": "./examples/create_web_hook.json" + } + } } }, "/webhooks/{id}": { @@ -5386,6 +7365,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5393,6 +7378,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -5400,6 +7391,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -5407,6 +7404,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5419,9 +7422,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Get a web hook": { + "$ref": "./examples/get_web_hook.json" + } + } }, "patch": { "tags": [ @@ -5474,6 +7482,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -5481,6 +7499,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5488,6 +7512,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "409": { @@ -5495,6 +7525,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -5502,6 +7538,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5514,9 +7556,14 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } - ] + ], + "x-ms-example": { + "Update a web hook": { + "$ref": "./examples/update_web hook.json" + } + } }, "delete": { "tags": [ @@ -5546,6 +7593,16 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, "x-ms-error-response": true }, "401": { @@ -5553,6 +7610,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5560,6 +7623,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -5574,6 +7643,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5586,7 +7661,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -5639,6 +7714,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5646,6 +7727,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -5653,6 +7740,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -5660,6 +7753,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5672,7 +7771,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -5732,6 +7831,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, "x-ms-error-response": true }, "403": { @@ -5739,6 +7844,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, "x-ms-error-response": true }, "404": { @@ -5746,6 +7857,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, "x-ms-error-response": true }, "429": { @@ -5753,6 +7870,12 @@ "schema": { "$ref": "#/definitions/Error" }, + "examples": { + "application/json": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5765,7 +7888,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ], "x-ms-long-running-operation": true, @@ -5822,7 +7945,7 @@ "security": [ { "subscription_key": [], - "token": [] + "token": [ ] } ] } @@ -7696,17 +9819,6 @@ } } }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - } - }, "securityDefinitions": { "subscription_key": { "type": "apiKey", @@ -7720,5 +9832,28 @@ "in": "header", "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" } + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/speechtotext/v3.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } } } From 3a647199897947af541a8f2bb9c8137d06af7651 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 09:02:43 +0100 Subject: [PATCH 21/34] prettify --- .../v2.0/examples/create _transcription.json | 2 +- .../v2.0/examples/create_accuracy_test.json | 2 +- .../stable/v2.0/examples/create_endpoint.json | 2 +- .../create_endpoint_data_exports.json | 2 +- .../stable/v2.0/examples/create_model.json | 2 +- .../v2.0/examples/get_accuracy_test.json | 2 +- .../v2.0/examples/get_accuracy_tests.json | 2 +- .../stable/v2.0/examples/get_dataset.json | 2 +- .../stable/v2.0/examples/get_datasets.json | 2 +- .../stable/v2.0/examples/get_endpoint.json | 2 +- .../examples/get_endpoint_data_export.json | 2 +- .../examples/get_endpoint_data_exports.json | 2 +- .../stable/v2.0/examples/get_endpoints.json | 2 +- .../stable/v2.0/examples/get_model.json | 2 +- .../stable/v2.0/examples/get_models.json | 2 +- .../get_supported_dataset_locales.json | 2 +- .../get_supported_endpoint_locales.json | 2 +- .../examples/get_supported_model_locales.json | 2 +- .../get_supported_transcription_locales.json | 2 +- .../v2.0/examples/get_transcription.json | 2 +- .../v2.0/examples/get_transcriptions.json | 2 +- .../v2.0/examples/update_accuracy_test.json | 2 +- .../stable/v2.0/examples/update_dataset.json | 2 +- .../stable/v2.0/examples/update_endpoint.json | 2 +- .../stable/v2.0/examples/update_model.json | 2 +- .../v2.0/examples/update_transcription.json | 2 +- .../stable/v2.0/examples/upload_dataset.json | 2 +- .../stable/v2.0/speechtotext.json | 136 ++++++++--------- .../stable/v3.0/examples/copy_model.json | 2 +- .../v3.0/examples/create _transcription.json | 2 +- .../stable/v3.0/examples/create_dataset.json | 2 +- .../stable/v3.0/examples/create_endpoint.json | 2 +- .../v3.0/examples/create_evaluation.json | 2 +- .../stable/v3.0/examples/create_model.json | 2 +- .../stable/v3.0/examples/create_project.json | 2 +- .../stable/v3.0/examples/create_web_hook.json | 2 +- .../stable/v3.0/examples/get_base_model.json | 2 +- .../v3.0/examples/get_base_model_log.json | 2 +- .../v3.0/examples/get_base_model_logs.json | 2 +- .../examples/get_base_model_manifest.json | 2 +- .../stable/v3.0/examples/get_base_models.json | 2 +- .../stable/v3.0/examples/get_dataset.json | 2 +- .../v3.0/examples/get_dataset_file.json | 2 +- .../v3.0/examples/get_dataset_files.json | 2 +- .../stable/v3.0/examples/get_datasets.json | 2 +- .../stable/v3.0/examples/get_endpoint.json | 2 +- .../v3.0/examples/get_endpoint_log.json | 2 +- .../v3.0/examples/get_endpoint_logs.json | 2 +- .../stable/v3.0/examples/get_endpoints.json | 2 +- .../stable/v3.0/examples/get_evaluation.json | 2 +- .../v3.0/examples/get_evaluation_file.json | 2 +- .../v3.0/examples/get_evaluation_files.json | 2 +- .../stable/v3.0/examples/get_evaluations.json | 2 +- .../stable/v3.0/examples/get_model.json | 2 +- .../v3.0/examples/get_model_manifest.json | 2 +- .../stable/v3.0/examples/get_models.json | 2 +- .../v3.0/examples/get_project_datasets.json | 2 +- .../v3.0/examples/get_project_endpoints.json | 2 +- .../examples/get_project_evaluations.json | 2 +- .../v3.0/examples/get_project_models.json | 2 +- .../examples/get_project_transcriptions.json | 2 +- .../stable/v3.0/examples/get_projects.json | 2 +- .../get_supported_dataset_locales.json | 2 +- .../get_supported_endpoint_locales.json | 2 +- .../get_supported_evaluations_locales.json | 2 +- .../examples/get_supported_model_locales.json | 2 +- .../get_supported_project_locales.json | 2 +- .../get_supported_transcription_locales.json | 2 +- .../v3.0/examples/get_transcription.json | 2 +- .../v3.0/examples/get_transcription_file.json | 2 +- .../examples/get_transcription_files.json | 2 +- .../v3.0/examples/get_transcriptions.json | 2 +- .../stable/v3.0/examples/get_web_hook.json | 2 +- .../stable/v3.0/examples/get_web_hooks.json | 2 +- .../stable/v3.0/examples/update_dataset.json | 2 +- .../stable/v3.0/examples/update_endpoint.json | 2 +- .../v3.0/examples/update_evaluation.json | 2 +- .../stable/v3.0/examples/update_model.json | 2 +- .../stable/v3.0/examples/update_project.json | 2 +- .../v3.0/examples/update_transcription.json | 2 +- .../stable/v3.0/examples/update_web hook.json | 2 +- .../stable/v3.0/examples/upload_dataset.json | 2 +- .../stable/v3.0/speechtotext.json | 138 +++++++++--------- 83 files changed, 218 insertions(+), 218 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json index 4e6e918b53f9..cab8db456ac1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json @@ -19,4 +19,4 @@ } }, "responses": {} -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json index 70960ec1cbca..a0f5b3e59ba7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json @@ -20,4 +20,4 @@ } }, "responses": {} -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json index e3034a6911a6..eb3050d77ef4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json @@ -17,4 +17,4 @@ } }, "responses": {} -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json index 14d1f8ab789e..d3931dc8cbab 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json @@ -9,4 +9,4 @@ } }, "responses": {} -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json index 33666a264d69..19f1e42562cd 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json @@ -19,4 +19,4 @@ } }, "responses": {} -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json index 813bb718490c..2f7cb5a33df4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json @@ -96,4 +96,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json index 8cbfad25e6a3..fab54d486ae1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json @@ -98,4 +98,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json index 059b639a9121..35987b429f46 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json @@ -22,4 +22,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json index bf63aed82633..07be905f35b2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json @@ -52,4 +52,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json index 8cc107c07221..913e2e2f7cec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json @@ -88,4 +88,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json index bfa144681f92..f742fbf253b3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json @@ -17,4 +17,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json index 1acad5c3844b..ba97431ea106 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json @@ -19,4 +19,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json index 5f7f8e87f613..fd93a0df615b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json @@ -90,4 +90,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json index 7ca1bd3b7137..fc06e446ec98 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json @@ -45,4 +45,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json index b61f367fe96d..cee09a2a5a28 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json @@ -73,4 +73,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json index 827c8852d7ed..34d32f7340d8 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json @@ -20,4 +20,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json index ad0adf228928..c1659390e825 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json @@ -12,4 +12,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json index 59eedb5955ee..9853dc4197d4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json @@ -17,4 +17,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json index ad0adf228928..c1659390e825 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json @@ -12,4 +12,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json index 6218cf89fe7e..25aa9f2842b6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json @@ -92,4 +92,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json index 968a6f1aabf7..0048496a097b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json @@ -94,4 +94,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json index 7f7afa880b90..29f86d0c16ea 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json @@ -101,4 +101,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json index e63c3cf4b56d..965eb211f651 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json @@ -27,4 +27,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json index ac229dd7719b..4d562f4ee7fb 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json @@ -93,4 +93,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json index bf017e0c39c8..b8b8832dd7e6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json @@ -50,4 +50,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json index 2e1787e22dbe..86584b81330b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json @@ -97,4 +97,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json index 58d21a38cde4..d70726beb510 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json @@ -14,4 +14,4 @@ } }, "responses": {} -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index df35724fa866..d52f50cd9516 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -132,8 +132,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -254,8 +254,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -425,8 +425,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -629,8 +629,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -764,8 +764,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -889,8 +889,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -1022,8 +1022,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -1193,8 +1193,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -1397,8 +1397,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -1559,8 +1559,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -1802,8 +1802,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -1939,8 +1939,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -2072,8 +2072,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -2252,8 +2252,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -2427,8 +2427,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -2562,8 +2562,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -2761,8 +2761,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -2899,8 +2899,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3062,8 +3062,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -3280,8 +3280,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -3456,8 +3456,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] }, @@ -3624,8 +3624,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -3754,8 +3754,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -3887,8 +3887,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -4067,8 +4067,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -4242,8 +4242,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -4446,8 +4446,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -4608,8 +4608,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } @@ -4736,8 +4736,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -4885,8 +4885,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -5065,8 +5065,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-long-running-operation": true, @@ -5240,8 +5240,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -5444,8 +5444,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ], "x-ms-example": { @@ -5609,8 +5609,8 @@ }, "security": [ { - "subscription_key": [ ], - "token": [ ] + "subscription_key": [], + "token": [] } ] } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json index c4f63e185eed..096c0c73a5f7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json @@ -39,4 +39,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json index 47416f14a3aa..ed61ec3d92fe 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json @@ -55,4 +55,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json index c33e768517a0..5ee14d235e44 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json @@ -34,4 +34,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json index 7dc365548b28..d07d5af3fc20 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json @@ -45,4 +45,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json index 00e06837f8b2..c4bf5119c436 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json @@ -67,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json index 1c4274fe469c..df4ffa4b53de 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json @@ -51,4 +51,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json index 5d357eb66ff0..6ea18b5ad2f3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json index f9179393ec7b..2e8e5b3f4ccd 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json @@ -39,4 +39,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json index b3e6354cfc7d..0ac9e762b15f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json @@ -25,4 +25,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json index 1b369e11ebaf..ec24a23ba5d3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json @@ -20,4 +20,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json index 466e6e31d3a5..23ca368f1969 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json index 267cd6d1ab16..76d26748a64c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json index 7c17a85a6549..d9766dbf191b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json @@ -47,4 +47,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json index c9956950e891..460a06e3a048 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json @@ -26,4 +26,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json index 854c95397562..0dc0c3f02d47 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json @@ -20,4 +20,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json index 7e57631c88bf..44dd546e5477 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json index 6b470bb086f6..07b05e727eb2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json @@ -69,4 +69,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json index 8a512190dbc1..e4191bb4a9a4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json index 1b369e11ebaf..ec24a23ba5d3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json @@ -20,4 +20,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json index c9b6b094fea9..3d77bebc6c89 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json index fdca1d2edc80..511a25c6a450 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json @@ -88,4 +88,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json index 37ca30bd2364..3bbf65963314 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json @@ -52,4 +52,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json index e8f5908f73aa..4bee0c8a77e2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json @@ -20,4 +20,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json index 8b419336f489..59372288c944 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json index bc067323ae24..b6e6c6a4cd0b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json @@ -145,4 +145,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json index f86d09d260e1..7dcec7c7a4f8 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json @@ -35,4 +35,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json index 267cd6d1ab16..76d26748a64c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json index b127def5f50f..98d0475ea437 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json @@ -67,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json index 6b470bb086f6..07b05e727eb2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json @@ -69,4 +69,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json index fdca1d2edc80..511a25c6a450 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json @@ -88,4 +88,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json index bc067323ae24..b6e6c6a4cd0b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json @@ -145,4 +145,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json index b127def5f50f..98d0475ea437 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json @@ -67,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json index b236667a561d..a535279efbed 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json @@ -45,4 +45,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json index 29a62e29cb03..11f8ab3076e0 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json @@ -28,4 +28,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json index 26de58b0f9b4..c689266f159c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json @@ -20,4 +20,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json index ad0adf228928..c1659390e825 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json @@ -12,4 +12,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json index ad0adf228928..c1659390e825 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json @@ -12,4 +12,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json index ad0adf228928..c1659390e825 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json @@ -12,4 +12,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json index ad0adf228928..c1659390e825 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json @@ -12,4 +12,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json index ad0adf228928..c1659390e825 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json @@ -12,4 +12,4 @@ ] } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json index 998137d62eeb..0f20c6de1b34 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json @@ -40,4 +40,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json index 854c95397562..0dc0c3f02d47 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json @@ -20,4 +20,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json index 7e57631c88bf..44dd546e5477 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json index b236667a561d..a535279efbed 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json @@ -45,4 +45,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json index 52fd2a6bc130..af476903b5d9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json @@ -27,4 +27,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json index 63f514673cfa..5d3fec2933b4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json @@ -70,4 +70,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json index f28c01a5c73a..de8bc3306860 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json @@ -30,4 +30,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json index 00294c534707..1e185d7032c3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json @@ -46,4 +46,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json index 88b14a6e6749..910bba41a627 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json @@ -57,4 +57,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json index 47b9aeb1b035..e7ba20572ab4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json @@ -43,4 +43,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json index 7ef76118d7cf..6172ff4f0a46 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json @@ -35,4 +35,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json index fd5590efcd3c..f5f01991fb2b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json index 2587d8f311e0..e7c2d6a5ccea 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json @@ -45,4 +45,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json index 7757b9cc6999..4f7b2912cf30 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 74aab99a230d..61a8edda51e5 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -76,7 +76,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -191,7 +191,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -307,7 +307,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -429,7 +429,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -562,7 +562,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -667,7 +667,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -832,7 +832,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -965,7 +965,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -1090,7 +1090,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -1169,7 +1169,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -1274,7 +1274,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -1390,7 +1390,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -1502,7 +1502,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -1613,7 +1613,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] }, @@ -1741,7 +1741,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -1883,7 +1883,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -2005,7 +2005,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -2130,7 +2130,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -2248,7 +2248,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -2378,7 +2378,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -2499,7 +2499,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -2623,7 +2623,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -2740,7 +2740,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -2814,7 +2814,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -2919,7 +2919,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -3025,7 +3025,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -3158,7 +3158,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -3283,7 +3283,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -3395,7 +3395,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -3528,7 +3528,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -3633,7 +3633,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -3707,7 +3707,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -3812,7 +3812,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -3928,7 +3928,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -4027,7 +4027,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -4143,7 +4143,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -4276,7 +4276,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -4381,7 +4381,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -4482,7 +4482,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -4618,7 +4618,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -4741,7 +4741,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -4864,7 +4864,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -4943,7 +4943,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -5042,7 +5042,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -5155,7 +5155,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -5261,7 +5261,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -5388,7 +5388,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -5493,7 +5493,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -5624,7 +5624,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -5764,7 +5764,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -5904,7 +5904,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -6044,7 +6044,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -6184,7 +6184,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -6267,7 +6267,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -6372,7 +6372,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -6488,7 +6488,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -6600,7 +6600,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -6733,7 +6733,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -6838,7 +6838,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -6966,7 +6966,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -7091,7 +7091,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -7196,7 +7196,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-pageable": { @@ -7310,7 +7310,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -7422,7 +7422,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -7556,7 +7556,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-example": { @@ -7661,7 +7661,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } @@ -7771,7 +7771,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-long-running-operation": true, @@ -7888,7 +7888,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ], "x-ms-long-running-operation": true, @@ -7945,7 +7945,7 @@ "security": [ { "subscription_key": [], - "token": [ ] + "token": [] } ] } From 1f6217e58cf91b67d5808565d7ae4a087cfe1aea Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 09:53:20 +0100 Subject: [PATCH 22/34] remove spaces in example file names --- .../{create _transcription.json => create_transcription.json} | 0 .../Speech/SpeechToText/stable/v2.0/speechtotext.json | 2 +- .../{create _transcription.json => create_transcription.json} | 0 .../examples/{update_web hook.json => update_web_hook.json} | 0 .../Speech/SpeechToText/stable/v3.0/speechtotext.json | 4 ++-- 5 files changed, 3 insertions(+), 3 deletions(-) rename specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/{create _transcription.json => create_transcription.json} (100%) rename specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/{create _transcription.json => create_transcription.json} (100%) rename specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/{update_web hook.json => update_web_hook.json} (100%) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json similarity index 100% rename from specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create _transcription.json rename to specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index d52f50cd9516..1ec05e4a0094 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -5075,7 +5075,7 @@ }, "x-ms-example": { "Create a transcription": { - "$ref": "./examples/create _transcription.json" + "$ref": "./examples/create_transcription.json" } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json similarity index 100% rename from specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create _transcription.json rename to specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json similarity index 100% rename from specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web hook.json rename to specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 61a8edda51e5..7253a4679404 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -6493,7 +6493,7 @@ ], "x-ms-example": { "Create a transcription": { - "$ref": "./examples/create _transcription.json" + "$ref": "./examples/create_transcription.json" } } } @@ -7561,7 +7561,7 @@ ], "x-ms-example": { "Update a web hook": { - "$ref": "./examples/update_web hook.json" + "$ref": "./examples/update_web_hook.json" } } }, From 773665603f07aca11f5d70e6cf162f81b439b841 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 10:07:29 +0100 Subject: [PATCH 23/34] use correct examples extension name --- .../stable/v2.0/speechtotext.json | 54 ++++----- .../stable/v3.0/speechtotext.json | 110 +++++++++--------- 2 files changed, 82 insertions(+), 82 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 1ec05e4a0094..36e8624abb9e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -136,7 +136,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get all accuracy tests": { "$ref": "./examples/get_accuracy_tests.json" } @@ -258,7 +258,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create an accuracy test": { "$ref": "./examples/create_accuracy_test.json" } @@ -429,7 +429,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get an accuracy test": { "$ref": "./examples/get_accuracy_test.json" } @@ -633,7 +633,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update an accuracy test": { "$ref": "./examples/update_accuracy_test.json" } @@ -893,7 +893,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_dataset_locales.json" } @@ -1026,7 +1026,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get all datasets": { "$ref": "./examples/get_datasets.json" } @@ -1197,7 +1197,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a dataset": { "$ref": "./examples/get_dataset.json" } @@ -1401,7 +1401,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a dataset": { "$ref": "./examples/update_dataset.json" } @@ -1810,7 +1810,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "location" }, - "x-ms-example": { + "x-ms-examples": { "Upload a dataset": { "$ref": "./examples/upload_dataset.json" } @@ -1943,7 +1943,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_endpoint_locales.json" } @@ -2076,7 +2076,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get all endpoints": { "$ref": "./examples/get_endpoints.json" } @@ -2260,7 +2260,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "location" }, - "x-ms-example": { + "x-ms-examples": { "Create an endpoint": { "$ref": "./examples/create_endpoint.json" } @@ -2431,7 +2431,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get an endpoint": { "$ref": "./examples/get_endpoint.json" } @@ -2765,7 +2765,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update an endpoint": { "$ref": "./examples/update_endpoint.json" } @@ -3066,7 +3066,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get all endpoint data exports": { "$ref": "./examples/get_endpoint_data_exports.json" } @@ -3288,7 +3288,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "location" }, - "x-ms-example": { + "x-ms-examples": { "Create an endpoint data exports": { "$ref": "./examples/create_endpoint_data_exports.json" } @@ -3628,7 +3628,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get an endpoint data export": { "$ref": "./examples/get_endpoint_data_export.json" } @@ -3758,7 +3758,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_model_locales.json" } @@ -3891,7 +3891,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get all models": { "$ref": "./examples/get_models.json" } @@ -4075,7 +4075,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "location" }, - "x-ms-example": { + "x-ms-examples": { "Create a model": { "$ref": "./examples/create_model.json" } @@ -4246,7 +4246,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a model": { "$ref": "./examples/get_model.json" } @@ -4450,7 +4450,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a model": { "$ref": "./examples/update_model.json" } @@ -4740,7 +4740,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_transcription_locales.json" } @@ -4889,7 +4889,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get all transcriptions": { "$ref": "./examples/get_transcriptions.json" } @@ -5073,7 +5073,7 @@ "x-ms-long-running-operation-options": { "final-state-via": "location" }, - "x-ms-example": { + "x-ms-examples": { "Create a transcription": { "$ref": "./examples/create_transcription.json" } @@ -5244,7 +5244,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a transcription": { "$ref": "./examples/get_transcription.json" } @@ -5448,7 +5448,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a transcription": { "$ref": "./examples/update_transcription.json" } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 7253a4679404..f943382b9fb4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -79,7 +79,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_dataset_locales.json" } @@ -198,7 +198,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all datasets": { "$ref": "./examples/get_datasets.json" } @@ -310,7 +310,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create a dataset": { "$ref": "./examples/create_dataset.json" } @@ -432,7 +432,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a dataset": { "$ref": "./examples/get_dataset.json" } @@ -565,7 +565,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a dataset": { "$ref": "./examples/update_dataset.json" } @@ -835,7 +835,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Upload a dataset": { "$ref": "./examples/upload_dataset.json" } @@ -972,7 +972,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all files": { "$ref": "./examples/get_dataset_files.json" } @@ -1093,7 +1093,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a file": { "$ref": "./examples/get_dataset_file.json" } @@ -1172,7 +1172,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_endpoint_locales.json" } @@ -1281,7 +1281,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all endpoints": { "$ref": "./examples/get_endpoints.json" } @@ -1393,7 +1393,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create an endpoint": { "$ref": "./examples/create_endpoint.json" } @@ -1505,7 +1505,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get an endpoint": { "$ref": "./examples/get_endpoint.json" } @@ -1744,7 +1744,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update an endpoint": { "$ref": "./examples/update_endpoint.json" } @@ -1890,7 +1890,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all endpoint logs": { "$ref": "./examples/get_endpoint_logs.json" } @@ -2133,7 +2133,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get an endpoint log": { "$ref": "./examples/get_endpoint_log.json" } @@ -2385,7 +2385,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all base model logs": { "$ref": "./examples/get_base_model_logs.json" } @@ -2626,7 +2626,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a base model log": { "$ref": "./examples/get_base_model_log.json" } @@ -2817,7 +2817,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_evaluations_locales.json" } @@ -2926,7 +2926,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all evaluations": { "$ref": "./examples/get_evaluations.json" } @@ -3028,7 +3028,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create a evaluation": { "$ref": "./examples/create_evaluation.json" } @@ -3165,7 +3165,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all files": { "$ref": "./examples/get_evaluation_files.json" } @@ -3286,7 +3286,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a file": { "$ref": "./examples/get_evaluation_file.json" } @@ -3398,7 +3398,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a evaluation": { "$ref": "./examples/get_evaluation.json" } @@ -3531,7 +3531,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a evaluation": { "$ref": "./examples/update_evaluation.json" } @@ -3710,7 +3710,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_model_locales.json" } @@ -3819,7 +3819,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all models": { "$ref": "./examples/get_models.json" } @@ -3931,7 +3931,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create a model": { "$ref": "./examples/create_model.json" } @@ -4034,7 +4034,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all base models": { "$ref": "./examples/get_base_models.json" } @@ -4146,7 +4146,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a model": { "$ref": "./examples/get_model.json" } @@ -4279,7 +4279,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a model": { "$ref": "./examples/update_model.json" } @@ -4485,7 +4485,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a base model": { "$ref": "./examples/get_base_model.json" } @@ -4621,7 +4621,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Copy a model": { "$ref": "./examples/copy_model.json" } @@ -4744,7 +4744,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a model manifest": { "$ref": "./examples/get_model_manifest.json" } @@ -4867,7 +4867,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a base model manifest": { "$ref": "./examples/get_base_model_manifest.json" } @@ -4946,7 +4946,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_project_locales.json" } @@ -5049,7 +5049,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all projects": { "$ref": "./examples/get_projects.json" } @@ -5158,7 +5158,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create a project": { "$ref": "./examples/create_project.json" } @@ -5264,7 +5264,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get all projects": { "$ref": "./examples/get_projects.json" } @@ -5391,7 +5391,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a project": { "$ref": "./examples/update_project.json" } @@ -5631,7 +5631,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all evaluations": { "$ref": "./examples/get_project_evaluations.json" } @@ -5771,7 +5771,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all datasets": { "$ref": "./examples/get_project_datasets.json" } @@ -5911,7 +5911,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all endpoints": { "$ref": "./examples/get_project_endpoints.json" } @@ -6051,7 +6051,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all models": { "$ref": "./examples/get_project_models.json" } @@ -6191,7 +6191,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all transcriptions": { "$ref": "./examples/get_project_transcriptions.json" } @@ -6270,7 +6270,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_transcription_locales.json" } @@ -6379,7 +6379,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all transcriptions": { "$ref": "./examples/get_transcriptions.json" } @@ -6491,7 +6491,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create a transcription": { "$ref": "./examples/create_transcription.json" } @@ -6603,7 +6603,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a transcription": { "$ref": "./examples/get_transcription.json" } @@ -6736,7 +6736,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a transcription": { "$ref": "./examples/update_transcription.json" } @@ -6973,7 +6973,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all files": { "$ref": "./examples/get_transcription_files.json" } @@ -7094,7 +7094,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a file": { "$ref": "./examples/get_transcription_file.json" } @@ -7203,7 +7203,7 @@ "itemName": "values", "nextLinkName": "@nextLink" }, - "x-ms-example": { + "x-ms-examples": { "Get all web hooks": { "$ref": "./examples/get_web_hooks.json" } @@ -7313,7 +7313,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Create a web hook": { "$ref": "./examples/create_web_hook.json" } @@ -7425,7 +7425,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Get a web hook": { "$ref": "./examples/get_web_hook.json" } @@ -7559,7 +7559,7 @@ "token": [] } ], - "x-ms-example": { + "x-ms-examples": { "Update a web hook": { "$ref": "./examples/update_web_hook.json" } From 0fea52ebb0bd9761016a6e04016d50758f235eed Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 17:55:59 +0100 Subject: [PATCH 24/34] Added updated examples --- .../v2.0/examples/create_accuracy_test.json | 28 +- .../stable/v2.0/examples/create_endpoint.json | 35 +- .../create_endpoint_data_exports.json | 43 +- .../stable/v2.0/examples/create_model.json | 35 +- .../v2.0/examples/create_transcription.json | 35 +- .../v2.0/examples/delete_accuracy_test.json | 34 + .../stable/v2.0/examples/delete_dataset.json | 41 + .../stable/v2.0/examples/delete_endpoint.json | 34 + .../v2.0/examples/delete_endpoint_data.json | 34 + .../examples/delete_endpoint_data_export.json | 42 + .../stable/v2.0/examples/delete_model.jsom | 41 + .../v2.0/examples/delete_transcription.json | 41 + .../v2.0/examples/get_accuracy_test.json | 39 +- .../v2.0/examples/get_accuracy_tests.json | 29 +- .../stable/v2.0/examples/get_dataset.json | 33 +- .../stable/v2.0/examples/get_datasets.json | 27 +- .../stable/v2.0/examples/get_endpoint.json | 37 +- .../examples/get_endpoint_data_export.json | 32 +- .../examples/get_endpoint_data_exports.json | 31 +- .../stable/v2.0/examples/get_endpoints.json | 27 +- .../stable/v2.0/examples/get_model.json | 35 +- .../stable/v2.0/examples/get_models.json | 27 +- .../get_supported_dataset_locales.json | 21 + .../get_supported_endpoint_locales.json | 21 + .../examples/get_supported_model_locales.json | 21 + .../get_supported_transcription_locales.json | 21 + .../v2.0/examples/get_transcription.json | 39 +- .../v2.0/examples/get_transcriptions.json | 29 +- .../v2.0/examples/update_accuracy_test.json | 48 +- .../stable/v2.0/examples/update_dataset.json | 42 +- .../stable/v2.0/examples/update_endpoint.json | 46 +- .../stable/v2.0/examples/update_model.json | 44 +- .../v2.0/examples/update_transcription.json | 48 +- .../stable/v2.0/examples/upload_dataset.json | 57 +- .../stable/v2.0/speechtotext.json | 829 +------ .../stable/v3.0/examples/copy_model.json | 50 +- .../stable/v3.0/examples/create_dataset.json | 42 +- .../stable/v3.0/examples/create_endpoint.json | 40 +- .../v3.0/examples/create_evaluation.json | 46 +- .../stable/v3.0/examples/create_model.json | 44 +- .../stable/v3.0/examples/create_project.json | 36 +- .../v3.0/examples/create_transcription.json | 42 +- .../stable/v3.0/examples/create_web_hook.json | 36 +- .../v3.0/examples/delete_base_model_log.json | 53 + .../v3.0/examples/delete_base_model_logs.json | 53 + .../stable/v3.0/examples/delete_dataset.json | 52 + .../stable/v3.0/examples/delete_endpoint.json | 52 + .../v3.0/examples/delete_endpoint_log.json | 53 + .../v3.0/examples/delete_endpoint_logs.json | 53 + .../v3.0/examples/delete_evaluation.json | 52 + .../stable/v3.0/examples/delete_model.jsom | 52 + .../stable/v3.0/examples/delete_project.json | 52 + .../v3.0/examples/delete_transcription.json | 52 + .../stable/v3.0/examples/delete_web_hook.json | 52 + .../stable/v3.0/examples/get_base_model.json | 46 +- .../v3.0/examples/get_base_model_log.json | 46 +- .../v3.0/examples/get_base_model_logs.json | 49 +- .../examples/get_base_model_manifest.json | 55 +- .../stable/v3.0/examples/get_base_models.json | 42 +- .../stable/v3.0/examples/get_dataset.json | 48 +- .../v3.0/examples/get_dataset_file.json | 46 +- .../v3.0/examples/get_dataset_files.json | 50 +- .../stable/v3.0/examples/get_datasets.json | 46 +- .../stable/v3.0/examples/get_endpoint.json | 44 +- .../v3.0/examples/get_endpoint_log.json | 46 +- .../v3.0/examples/get_endpoint_logs.json | 49 +- .../stable/v3.0/examples/get_endpoints.json | 134 +- .../stable/v3.0/examples/get_evaluation.json | 48 +- .../v3.0/examples/get_evaluation_file.json | 46 +- .../v3.0/examples/get_evaluation_files.json | 47 +- .../stable/v3.0/examples/get_evaluations.json | 56 +- .../stable/v3.0/examples/get_model.json | 48 +- .../v3.0/examples/get_model_manifest.json | 55 +- .../stable/v3.0/examples/get_models.json | 46 +- .../stable/v3.0/examples/get_project.json | 71 + .../v3.0/examples/get_project_datasets.json | 54 +- .../v3.0/examples/get_project_endpoints.json | 56 +- .../examples/get_project_evaluations.json | 64 +- .../v3.0/examples/get_project_models.json | 54 +- .../examples/get_project_transcriptions.json | 52 +- .../stable/v3.0/examples/get_projects.json | 117 +- .../get_supported_dataset_locales.json | 21 + .../get_supported_endpoint_locales.json | 21 + .../get_supported_evaluations_locales.json | 21 + .../examples/get_supported_model_locales.json | 21 + .../get_supported_project_locales.json | 21 + .../get_supported_transcription_locales.json | 21 + .../v3.0/examples/get_transcription.json | 48 +- .../v3.0/examples/get_transcription_file.json | 50 +- .../examples/get_transcription_files.json | 59 +- .../v3.0/examples/get_transcriptions.json | 44 +- .../stable/v3.0/examples/get_web_hook.json | 42 +- .../stable/v3.0/examples/get_web_hooks.json | 38 +- .../stable/v3.0/examples/ping_web_hook.json | 52 + .../stable/v3.0/examples/test_web_hook.json | 56 + .../stable/v3.0/examples/update_dataset.json | 62 +- .../stable/v3.0/examples/update_endpoint.json | 46 +- .../v3.0/examples/update_evaluation.json | 50 +- .../stable/v3.0/examples/update_model.json | 50 +- .../stable/v3.0/examples/update_project.json | 44 +- .../v3.0/examples/update_transcription.json | 50 +- .../stable/v3.0/examples/update_web_hook.json | 44 +- .../stable/v3.0/examples/upload_dataset.json | 65 +- .../stable/v3.0/speechtotext.json | 1953 +---------------- 104 files changed, 4290 insertions(+), 3042 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json index a0f5b3e59ba7..9bc9ce00b979 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json @@ -2,7 +2,6 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "testDefinition": { "models": [ { @@ -17,7 +16,30 @@ }, "name": "Accuracy test", "description": "This is an accuracy test" - } + }, + "Content-Type": "application/json" }, - "responses": {} + "responses": { + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json index eb3050d77ef4..c7ad33ed57be 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json @@ -2,7 +2,6 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "endpointDefinition": { "models": [ { @@ -14,7 +13,37 @@ "locale": "en-US", "name": "Speech endpoint definition", "description": "This is a speech endpoint" - } + }, + "Content-Type": "application/json" }, - "responses": {} + "responses": { + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json index d3931dc8cbab..ae7a3035a0d0 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json @@ -2,11 +2,48 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6", "endpointDataDefinition": { "startDate": "2018-12-08T00:00:00Z", "endDate": "2019-01-07T00:00:00Z" - } + }, + "Content-Type": "application/json" }, - "responses": {} + "responses": { + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json index 19f1e42562cd..5b8263d03524 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json @@ -2,7 +2,6 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "modelDefinition": { "modelKind": "Language", "baseModel": { @@ -16,7 +15,37 @@ "locale": "en-US", "name": "Language model", "description": "This is a language model definition" - } + }, + "Content-Type": "application/json" }, - "responses": {} + "responses": { + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json index cab8db456ac1..13e8be76511e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json @@ -2,7 +2,6 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "transcription": { "recordingsUrl": "https://contoso.com/mystoragelocation", "models": [], @@ -16,7 +15,37 @@ "ProfanityFilterMode": "Masked", "PunctuationMode": "DictatedAndAutomatic" } - } + }, + "Content-Type": "application/json" }, - "responses": {} + "responses": { + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json new file mode 100644 index 000000000000..f4a5d25d771d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json new file mode 100644 index 000000000000..8c7c0729aac6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json new file mode 100644 index 000000000000..016d7c42caf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json new file mode 100644 index 000000000000..a513b703ab17 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json new file mode 100644 index 000000000000..9d7b4ef0e6e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom new file mode 100644 index 000000000000..9e252b60e162 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json new file mode 100644 index 000000000000..5f0814b0f9bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json index 2f7cb5a33df4..c836c7b3e810 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060" }, "responses": { "200": { @@ -22,7 +23,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -59,13 +60,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -83,7 +84,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } }, "wordErrorRate": 0.0, @@ -94,6 +95,34 @@ "status": "Running", "name": "Accuracy test" } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json index fab54d486ae1..0946c13b8a19 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json @@ -23,7 +23,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -60,13 +60,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -84,7 +84,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } }, "wordErrorRate": 0.0, @@ -96,6 +96,27 @@ "name": "Accuracy test" } ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json index 35987b429f46..f30f112057da 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "responses": { "200": { @@ -17,9 +18,37 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json index 07be905f35b2..1534811bb997 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json @@ -18,7 +18,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } }, { @@ -32,7 +32,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/PronunciationData/71e831ef-ba18-4fbb-8559-cea56f98284f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=5b69ed9e-e848-461b-8f4e-78851bc82f07" + "ReportUri": "https://www.contoso.com/PronunciationData/71e831ef-ba18-4fbb-8559-cea56f98284f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=5b69ed9e-e848-461b-8f4e-78851bc82f07" } }, { @@ -46,10 +46,31 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json index 913e2e2f7cec..ce9aa549e1a4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" }, "responses": { "200": { @@ -23,7 +24,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -60,13 +61,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -86,6 +87,34 @@ "name": "Speech endpoint", "description": "Example for speech endpoint" } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json index f742fbf253b3..c7a2bbf02745 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "id": "9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a" }, "responses": { "200": { @@ -15,6 +17,34 @@ "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Succeeded" } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json index ba97431ea106..6c6c78757947 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpointId": "afa0669c-a01e-4693-ae3a-93baf40f26d6" }, "responses": { "200": { @@ -17,6 +18,34 @@ "status": "Succeeded" } ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json index fd93a0df615b..95c8dd37b8d4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json @@ -24,7 +24,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -61,13 +61,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -88,6 +88,27 @@ "description": "Example for speech endpoint" } ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json index fc06e446ec98..8fd2f2a3809a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" }, "responses": { "200": { @@ -31,18 +32,46 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", "description": "This is a language model" } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json index cee09a2a5a28..3fac3cba7299 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json @@ -32,13 +32,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -58,7 +58,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -71,6 +71,27 @@ "description": "Example for an acoustic model" } ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json index 34d32f7340d8..11005cadb75d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json @@ -18,6 +18,27 @@ "en-US" ] } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json index c1659390e825..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json @@ -10,6 +10,27 @@ "en-US", "de-DE" ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json index 9853dc4197d4..200b0762d0ae 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json @@ -15,6 +15,27 @@ "de-DE" ] } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json index c1659390e825..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json @@ -10,6 +10,27 @@ "en-US", "de-DE" ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json index 25aa9f2842b6..0dd12dda929a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "responses": { "200": { @@ -28,7 +29,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -65,13 +66,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -80,7 +81,7 @@ ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Succeeded", - "id": "9891c965-bb32-4880-b14b-6d44efb158f3", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Transcription using locale en-US", @@ -90,6 +91,34 @@ "Duration": "00:00:42" } } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json index 0048496a097b..7516d4320d80 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json @@ -29,7 +29,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -66,13 +66,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -81,7 +81,7 @@ ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Succeeded", - "id": "9891c965-bb32-4880-b14b-6d44efb158f3", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Transcription using locale en-US", @@ -92,6 +92,27 @@ } } ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json index 29f86d0c16ea..2626dfc7e8d1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json @@ -2,11 +2,12 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "0000e4c4-0b0e-437f-b41d-bcfe7ebf7060", "testUpdate": { "name": "Updated test name", "description": "Updated test description" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -27,7 +28,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -64,13 +65,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -88,7 +89,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } }, "wordErrorRate": 0.0, @@ -99,6 +100,41 @@ "status": "Running", "name": "Accuracy test" } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json index 965eb211f651..efdbcebac377 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json @@ -2,11 +2,12 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", "datasetUpdate": { "name": "Updated dataset name", "description": "Updated dataset description" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -22,9 +23,44 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json index 4d562f4ee7fb..dd9cf46bb0c4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json @@ -2,11 +2,12 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", "endpointUpdate": { "name": "Updated speech endpoint", "description": "Example for an updated speech endpoint" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -28,7 +29,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -65,13 +66,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -91,6 +92,41 @@ "name": "Speech endpoint", "description": "Example for speech endpoint" } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json index b8b8832dd7e6..49bb4f0d9a2f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json @@ -2,11 +2,12 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "modelUpdate": { "name": "Language model update", "description": "This is a language model update" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -36,18 +37,53 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", "description": "This is a language model" } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json index 86584b81330b..b2b0168dded3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json @@ -2,11 +2,12 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", "transcriptionUpdate": { "name": "Updated transcription name", "description": "Updated transcription description" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -33,7 +34,7 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" } } ], @@ -70,13 +71,13 @@ "properties": { "AcceptedLines": "11", "RejectedLines": "2", - "ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" } } ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Running", - "id": "ff3c2797-f5f0-4122-9712-83ee87a0abb8", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Language model", @@ -85,7 +86,7 @@ ], "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Succeeded", - "id": "9891c965-bb32-4880-b14b-6d44efb158f3", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "name": "Transcription using locale en-US", @@ -95,6 +96,41 @@ "Duration": "00:00:42" } } + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json index d70726beb510..0c77eebe950a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json @@ -2,16 +2,55 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", + "name": "My speech dataset name", "Content-Type": "multipart/form-data", - "form-data": { - "name": "My speech dataset name", - "description": "My speech dataset description", - "locale": "en-US", - "dataImportKind": "Acoustic", - "properties": { - "property": "true" + "description": "My speech dataset description", + "locale": "en-us", + "dataImportKind": "Acoustic", + "properties": "{ \"property\": \"true\" }", + "audiodata": "multipart-form-data", + "transcriptions": "multipart-form-data", + "languagedata": "multipart-form-data" + }, + "responses": { + "202": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "415": { + "headers": {}, + "body": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } - }, - "responses": {} + } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 36e8624abb9e..4cb1c6e611b7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -49,12 +49,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -76,12 +70,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -103,12 +91,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -171,12 +153,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -198,12 +174,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -225,12 +195,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -315,12 +279,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -342,12 +300,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -369,12 +321,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -396,12 +342,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -492,12 +432,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -519,12 +453,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -546,12 +474,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -573,12 +495,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -600,12 +516,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -681,12 +591,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -708,12 +612,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -735,12 +633,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -767,7 +659,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete an accuracy test": { + "$ref": "./examples/delete_accuracy_test.json" + } + } } }, "/datasets/locales": { @@ -806,12 +703,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -833,12 +724,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -860,12 +745,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -939,12 +818,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -966,12 +839,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -993,12 +860,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1083,12 +944,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1110,12 +965,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1137,12 +986,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1164,12 +1007,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1260,12 +1097,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1287,12 +1118,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1314,12 +1139,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1341,12 +1160,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1368,12 +1181,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1449,12 +1256,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1476,12 +1277,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1503,12 +1298,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1530,12 +1319,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1562,7 +1345,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } } }, "/datasets/upload": { @@ -1665,12 +1453,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1692,12 +1474,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1719,12 +1495,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1746,12 +1516,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "UnsupportedMediaType", - "message": "The request entity's media type 'application/xml' is not supported for this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1773,12 +1537,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1856,12 +1614,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1883,12 +1635,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1910,12 +1656,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -1989,12 +1729,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2016,12 +1750,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2043,12 +1771,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2142,12 +1864,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2169,12 +1885,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2196,12 +1906,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2223,12 +1927,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2317,12 +2015,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2344,12 +2036,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2371,12 +2057,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2398,12 +2078,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2479,12 +2153,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2506,12 +2174,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2533,12 +2195,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2565,7 +2221,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete an endpoint": { + "$ref": "./examples/delete_endpoint.json" + } + } }, "patch": { "tags": [ @@ -2624,12 +2285,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2651,12 +2306,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2678,12 +2327,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2705,12 +2348,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2732,12 +2369,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2816,12 +2447,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2843,12 +2468,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2870,12 +2489,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2902,7 +2515,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete the data for an endpoint": { + "$ref": "./examples/delete_endpoint_data.json" + } + } }, "get": { "tags": [ @@ -2952,12 +2570,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -2979,12 +2591,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3006,12 +2612,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3033,12 +2633,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3143,12 +2737,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3170,12 +2758,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3197,12 +2779,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3224,12 +2800,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3251,12 +2821,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3346,12 +2910,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3373,12 +2931,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3400,12 +2952,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3427,12 +2973,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3459,7 +2999,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a data export for an endpoint": { + "$ref": "./examples/delete_endpoint_data_export.json" + } + } }, "get": { "tags": [ @@ -3514,12 +3059,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3541,12 +3080,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3568,12 +3101,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3595,12 +3122,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3671,12 +3192,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3698,12 +3213,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3725,12 +3234,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3804,12 +3307,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3831,12 +3328,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3858,12 +3349,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3957,12 +3442,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -3984,12 +3463,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4011,12 +3484,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4038,12 +3505,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4132,12 +3593,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4159,12 +3614,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4186,12 +3635,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4213,12 +3656,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4309,12 +3746,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4336,12 +3767,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4363,12 +3788,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4390,12 +3809,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4417,12 +3830,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4498,12 +3905,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4525,12 +3926,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4552,12 +3947,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4579,12 +3968,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4611,7 +3994,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a model": { + "$ref": "./examples/delete_model.jsom" + } + } } }, "/transcriptions/locales": { @@ -4653,12 +4041,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4680,12 +4062,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4707,12 +4083,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4802,12 +4172,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4829,12 +4193,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4856,12 +4214,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4955,12 +4307,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -4982,12 +4328,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5009,12 +4349,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5036,12 +4370,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5130,12 +4458,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5157,12 +4479,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5184,12 +4500,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5211,12 +4521,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5307,12 +4611,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5334,12 +4632,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5361,12 +4653,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5388,12 +4674,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5415,12 +4695,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5499,12 +4773,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5526,12 +4794,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5553,12 +4815,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5580,12 +4836,6 @@ "schema": { "$ref": "#/definitions/ErrorContent" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "X-RateLimit-Limit": { "description": "The limit of requests for the resource.", @@ -5612,7 +4862,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a transcription": { + "$ref": "./examples/delete_transcription.json" + } + } } } }, diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json index 096c0c73a5f7..80a7eaf783fe 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json @@ -2,16 +2,17 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "modelCopy": { "targetSubscriptionKey": "KeyForTheSubscriptionTheModelIsSupposedToBeCopiedTo" - } + }, + "Content-Type": "application/json" }, "responses": { "201": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", "baseModel": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, @@ -21,8 +22,8 @@ } ], "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", - "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" }, "properties": { "deprecationDates": { @@ -37,6 +38,45 @@ "displayName": "Language model", "description": "This is a language model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json index 5ee14d235e44..1a32cdc6907b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json @@ -2,24 +2,24 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "dataset": { "kind": "Acoustic", "contentUrl": "https://contoso.com/location", "locale": "en-US", "displayName": "My speech dataset name", "description": "My speech dataset description" - } + }, + "Content-Type": "application/json" }, "responses": { "201": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", "kind": "Acoustic", - "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" }, "properties": { "acceptedLineCount": 11, @@ -32,6 +32,38 @@ "locale": "en-US", "displayName": "Acoustic dataset" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json index d07d5af3fc20..1bbf198d660a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json @@ -2,10 +2,9 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "endpoint": { "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "properties": { "loggingEnabled": true @@ -13,7 +12,8 @@ "locale": "en-US", "displayName": "Speech endpoint definition", "description": "This is a speech endpoint" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -21,7 +21,7 @@ "body": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", @@ -43,6 +43,38 @@ "displayName": "Speech endpoint", "description": "Example for speech endpoint" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json index c4bf5119c436..d10a6791ac50 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json @@ -2,21 +2,21 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "evaluation": { "model1": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "locale": "en-US", "displayName": "My new evaluation", "description": "The description of the evaluation" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -27,16 +27,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -65,6 +65,38 @@ "locale": "en-US", "displayName": "Evalution of one model against another model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json index df4ffa4b53de..55b1d1f6c98f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json @@ -2,14 +2,13 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "model": { "baseModel": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "datasets": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" @@ -17,13 +16,14 @@ ], "locale": "en-US", "displayName": "Model with acoustic and language datasets" - } + }, + "Content-Type": "application/json" }, "responses": { "201": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", "baseModel": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, @@ -33,8 +33,8 @@ } ], "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", - "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" }, "properties": { "deprecationDates": { @@ -49,6 +49,38 @@ "displayName": "Language model", "description": "This is a language model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json index 6ea18b5ad2f3..ae70359d9a72 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json @@ -2,11 +2,11 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "project": { "locale": "en-US", "displayName": "My speech project" - } + }, + "Content-Type": "application/json" }, "responses": { "201": { @@ -31,6 +31,38 @@ "locale": "en-US", "displayName": "My speech project" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json index ed61ec3d92fe..9c1ee6474499 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json @@ -2,7 +2,6 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "transcription": { "contentUrls": [ "https://contoso.com/mystoragelocation", @@ -16,22 +15,23 @@ }, "locale": "en-US", "displayName": "Transcription using default model for en-US" - } + }, + "Content-Type": "application/json" }, "responses": { "201": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", "contentUrls": [ "https://contoso.com/", "https://contoso2.com/" ], "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" }, "properties": { "diarizationEnabled": false, @@ -53,6 +53,38 @@ "key": "value" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json index 2e8e5b3f4ccd..d6daca7eedd2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json @@ -2,7 +2,6 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "webHook": { "displayName": "TranscriptionCompletionWebHook", "properties": { @@ -13,7 +12,8 @@ "transcriptionCompletion": true }, "description": "I registered this URL to get a POST request for each completed transcription." - } + }, + "Content-Type": "application/json" }, "responses": { "201": { @@ -37,6 +37,38 @@ "lastActionDateTime": "2018-11-28T00:00:00Z", "status": "NotStarted" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json new file mode 100644 index 000000000000..1cd287a4f3a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json new file mode 100644 index 000000000000..e87251d80ed3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "endDate": "2019-01-01" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json new file mode 100644 index 000000000000..7d07e11cb8e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json new file mode 100644 index 000000000000..41843acdaef3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json new file mode 100644 index 000000000000..6c28a83ea685 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json new file mode 100644 index 000000000000..c06ee4cf2ab4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endDate": "2019-01-01" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json new file mode 100644 index 000000000000..203e82712d6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom new file mode 100644 index 000000000000..11ce645b5b73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json new file mode 100644 index 000000000000..6f0ac322c53b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json new file mode 100644 index 000000000000..2dce0832ee87 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json new file mode 100644 index 000000000000..a842e83b2ba4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json index 0ac9e762b15f..9bea763bf362 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json @@ -1,15 +1,16 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/827712a5-f942-4997-91c3-7c6cde35600b", "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" }, "properties": { "deprecationDates": { @@ -23,6 +24,45 @@ "locale": "en-US", "displayName": "en-US Base model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json index ec24a23ba5d3..8841c8c3fe78 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json @@ -1,13 +1,16 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "logId": 10, + "$sasValidityInSeconds": 120 }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "kind": "Audio", "properties": { @@ -18,6 +21,45 @@ "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json index 23ca368f1969..90da33828e38 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json @@ -1,7 +1,11 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "$sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "$top": 10 }, "responses": { "200": { @@ -9,7 +13,7 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "kind": "Audio", "properties": { @@ -21,7 +25,7 @@ } }, { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", "kind": "Transcription", "properties": { @@ -35,6 +39,45 @@ ], "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/base/en-us/files/logs?top=2&SkipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json index 76d26748a64c..bc104cf762a6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "$sasValidityInSeconds": 120 }, "responses": { "200": { @@ -13,27 +15,27 @@ "modelFiles": [ { "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", - "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=wgSFvL8ParcZsckXWbr%2BSYYdPXHr2srdevD%2FoX4Ay7g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=D7Ql1riMUbmaFSX7DpuOitS4mZTOIbJPoB1qfVEP8DY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=Hf%2B50Pxox02NMdxmlcDZEDMWhUEz8nHE0L0aAkiDnWY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=pTv1hsjG111Nwl%2FGdwZbNfXDIfx5EBIzkTO6OksSC9g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=RS5wj8nw7cCMp3IrBVPdH6fLBznfuk%2FH%2BcuUQ8DfSh0%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=yqsHvDR9nLn3lyFFbi9U%2BxbRwWsfWD0qoSiri3buLkA%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" } ], "properties": { @@ -46,6 +48,45 @@ "IN_NBestBeamSize": 1 } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json index d9766dbf191b..3a59f60963da 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,9 +11,9 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/827712a5-f942-4997-91c3-7c6cde35600b", "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" }, "properties": { "deprecationDates": { @@ -43,7 +45,39 @@ "displayName": "de-DE Base model" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=2&top=2" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json index 460a06e3a048..5ae01638b0bc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json @@ -1,17 +1,18 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", "kind": "Acoustic", - "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" }, "properties": { "acceptedLineCount": 11, @@ -24,6 +25,45 @@ "locale": "en-US", "displayName": "Acoustic dataset" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json index 0dc0c3f02d47..f4212dcc2277 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json @@ -1,13 +1,16 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "$sasValidityInSeconds": 120 }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", "name": "Name", "kind": "DatasetReport", "properties": { @@ -18,6 +21,45 @@ "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json index 44dd546e5477..f1ba30e215dd 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json @@ -1,7 +1,12 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "$sasValidityInSeconds": 120, + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,7 +14,7 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", "name": "Name", "kind": "DatasetReport", "properties": { @@ -33,7 +38,46 @@ } } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/db2cb8bf-717a-4f41-b337-a6bc29a18549/files?skip=2&top=2" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json index 07b05e727eb2..66918b6d761e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,11 +11,11 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", "kind": "Acoustic", - "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" }, "properties": { "acceptedLineCount": 11, @@ -29,7 +31,7 @@ { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", "kind": "Language", - "contentUrl": "https://www.example.org/LanguageData/SourceLocation", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" }, @@ -46,7 +48,7 @@ { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b", "kind": "Pronunciation", - "contentUrl": "https://www.example.org/PronunciationData/SourceLocation", + "contentUrl": "https://www.contoso.com/PronunciationData/SourceLocation", "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b/files" }, @@ -67,6 +69,38 @@ ], "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets?skip=3&top=3" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json index e4191bb4a9a4..f46b912e0a50 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" }, "responses": { "200": { @@ -9,7 +10,7 @@ "body": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", @@ -31,6 +32,45 @@ "displayName": "Speech endpoint", "description": "Example for speech endpoint" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json index ec24a23ba5d3..3aa8f14a5c40 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json @@ -1,13 +1,16 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "$sasValidityInSeconds": 120 }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "kind": "Audio", "properties": { @@ -18,6 +21,45 @@ "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json index 3d77bebc6c89..363fd53e7023 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json @@ -1,7 +1,11 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "$sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "$top": 10 }, "responses": { "200": { @@ -9,7 +13,7 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", "kind": "Audio", "properties": { @@ -21,7 +25,7 @@ } }, { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/6d72ad7e-f286-4a6f-b81b-a0532ca6bcaa/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", "kind": "Transcription", "properties": { @@ -35,6 +39,45 @@ ], "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&SkipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json index 511a25c6a450..00851c8e53c1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,82 +11,96 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", - "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" - }, + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", "links": { - "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", - "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" }, "properties": { - "timeToLive": "PT30M", - "loggingEnabled": true + "apiVersion": "v3.0" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true }, - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "displayName": "Speech endpoint", - "description": "Example for speech endpoint" + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" }, { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", - "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" - }, + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", "links": { - "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", - "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" }, "properties": { - "timeToLive": "PT30M", - "loggingEnabled": true + "apiVersion": "v3.0" }, - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "displayName": "Speech endpoint", - "description": "Example for speech endpoint" + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" }, { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", - "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" - }, + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/034034ec-2872-43e0-b1e5-f57735e253bf", "links": { - "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", - "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", - "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" }, "properties": { - "timeToLive": "PT30M", - "loggingEnabled": true + "apiVersion": "v3.0" }, - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "displayName": "Speech endpoint", - "description": "Example for speech endpoint" + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=3&top=3" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json index 3bbf65963314..5538b3404b22 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" }, "responses": { "200": { @@ -12,16 +13,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -50,6 +51,45 @@ "locale": "en-US", "displayName": "Evalution of one model against another model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json index 4bee0c8a77e2..0cc218837ed2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json @@ -1,13 +1,16 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "$sasValidityInSeconds": 120 }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/33c0c641-acb0-41f7-b87d-2783e8b9c2b1", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", "name": "Name", "kind": "EvaluationDetails", "properties": { @@ -18,6 +21,45 @@ "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json index 59372288c944..33181fd0550a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json @@ -1,7 +1,11 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "$sasValidityInSeconds": 120, + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -21,7 +25,7 @@ } }, { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/33c0c641-acb0-41f7-b87d-2783e8b9c2b1", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", "name": "Name", "kind": "EvaluationDetails", "properties": { @@ -35,6 +39,45 @@ ], "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json index b6e6c6a4cd0b..2e96aeb25bd9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -14,16 +16,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -58,16 +60,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -102,16 +104,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -141,7 +143,39 @@ "displayName": "Evalution of one model against another model" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=3&top=3" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json index 7dcec7c7a4f8..3b09e852b75a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json @@ -1,13 +1,14 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", "baseModel": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, @@ -17,8 +18,8 @@ } ], "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", - "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" }, "properties": { "deprecationDates": { @@ -33,6 +34,45 @@ "displayName": "Language model", "description": "This is a language model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json index 76d26748a64c..bc104cf762a6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "$sasValidityInSeconds": 120 }, "responses": { "200": { @@ -13,27 +15,27 @@ "modelFiles": [ { "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", - "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=wgSFvL8ParcZsckXWbr%2BSYYdPXHr2srdevD%2FoX4Ay7g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=D7Ql1riMUbmaFSX7DpuOitS4mZTOIbJPoB1qfVEP8DY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=Hf%2B50Pxox02NMdxmlcDZEDMWhUEz8nHE0L0aAkiDnWY%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=pTv1hsjG111Nwl%2FGdwZbNfXDIfx5EBIzkTO6OksSC9g%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=RS5wj8nw7cCMp3IrBVPdH6fLBznfuk%2FH%2BcuUQ8DfSh0%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" }, { "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", - "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=yqsHvDR9nLn3lyFFbi9U%2BxbRwWsfWD0qoSiri3buLkA%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" } ], "properties": { @@ -46,6 +48,45 @@ "IN_NBestBeamSize": 1 } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json index 98d0475ea437..80409084589a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,7 +11,7 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", "baseModel": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, @@ -19,8 +21,8 @@ } ], "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", - "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" }, "properties": { "deprecationDates": { @@ -42,7 +44,7 @@ }, "datasets": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" } ], "links": { @@ -63,7 +65,39 @@ "description": "Example for an acoustic model" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=2&top=2" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json new file mode 100644 index 000000000000..006fb32cf234 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json index 07b05e727eb2..9668663797fe 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json @@ -1,7 +1,10 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,11 +12,11 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", "kind": "Acoustic", - "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" }, "properties": { "acceptedLineCount": 11, @@ -29,7 +32,7 @@ { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", "kind": "Language", - "contentUrl": "https://www.example.org/LanguageData/SourceLocation", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" }, @@ -46,7 +49,7 @@ { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b", "kind": "Pronunciation", - "contentUrl": "https://www.example.org/PronunciationData/SourceLocation", + "contentUrl": "https://www.contoso.com/PronunciationData/SourceLocation", "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/d3910eba-c576-4886-afaa-886bb363822b/files" }, @@ -67,6 +70,45 @@ ], "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets?skip=3&top=3" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json index 511a25c6a450..8a706c722441 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json @@ -1,7 +1,10 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -11,7 +14,7 @@ { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", @@ -36,7 +39,7 @@ { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", @@ -61,7 +64,7 @@ { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" }, "links": { "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", @@ -74,17 +77,56 @@ }, "properties": { "timeToLive": "PT30M", - "loggingEnabled": true + "loggingEnabled": false }, "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", + "status": "NotStarted", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", "displayName": "Speech endpoint", "description": "Example for speech endpoint" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=3&top=3" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json index b6e6c6a4cd0b..37a7a1f9f1ab 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json @@ -1,7 +1,10 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -14,16 +17,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -58,16 +61,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -102,16 +105,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -141,7 +144,46 @@ "displayName": "Evalution of one model against another model" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=3&top=3" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json index 98d0475ea437..a73bcd8550ea 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json @@ -1,7 +1,10 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,7 +12,7 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", "baseModel": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, @@ -19,8 +22,8 @@ } ], "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", - "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" }, "properties": { "deprecationDates": { @@ -42,7 +45,7 @@ }, "datasets": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" } ], "links": { @@ -63,7 +66,46 @@ "description": "Example for an acoustic model" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=2&top=2" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json index a535279efbed..c8de29e03298 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json @@ -1,7 +1,10 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,16 +12,16 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", "contentUrls": [ "https://contoso.com/", "https://contoso2.com/" ], "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" }, "properties": { "diarizationEnabled": false, @@ -41,7 +44,46 @@ } } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=100&top=100" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json index 11f8ab3076e0..ce42e5aefabc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json @@ -1,30 +1,109 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", - "links": { - "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", - "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", - "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", - "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", - "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" - }, - "properties": { - "datasetCount": 23, - "evaluationCount": 42, - "modelCount": 2, - "transcriptionCount": 1994, - "endpointCount": 12 - }, - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "displayName": "My speech project" + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json index c689266f159c..b910b5b5f1b7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json @@ -18,6 +18,27 @@ "AudioFiles" ] } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json index c1659390e825..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json @@ -10,6 +10,27 @@ "en-US", "de-DE" ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json index c1659390e825..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json @@ -10,6 +10,27 @@ "en-US", "de-DE" ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json index c1659390e825..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json @@ -10,6 +10,27 @@ "en-US", "de-DE" ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json index c1659390e825..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json @@ -10,6 +10,27 @@ "en-US", "de-DE" ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json index c1659390e825..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json @@ -10,6 +10,27 @@ "en-US", "de-DE" ] + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json index 0f20c6de1b34..7a72fb77b45b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json @@ -1,22 +1,23 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", "contentUrls": [ "https://contoso.com/", "https://contoso2.com/" ], "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" }, "properties": { "diarizationEnabled": false, @@ -38,6 +39,45 @@ "key": "value" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json index 0dc0c3f02d47..f59eaac60925 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json @@ -1,23 +1,65 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "$sasValidityInSeconds": 120, + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29" }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", "name": "Name", - "kind": "DatasetReport", + "kind": "Transcription", "properties": { "size": 200 }, "createdDateTime": "2020-01-13T08:00:00Z", "links": { - "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json index 44dd546e5477..d7e9e1f2582c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json @@ -1,7 +1,11 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "$sasValidityInSeconds": 120, + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,31 +13,70 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", "name": "Name", - "kind": "DatasetReport", + "kind": "Transcription", "properties": { "size": 200 }, "createdDateTime": "2020-01-13T08:00:00Z", "links": { - "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" } }, { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files/f035cf2d-4051-4131-85e7-97e3a7349c86", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef", "name": "Name", - "kind": "LanguageData", + "kind": "Transcription", "properties": { "size": 200 }, "createdDateTime": "2020-01-13T08:00:00Z", "links": { - "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" } } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/db2cb8bf-717a-4f41-b337-a6bc29a18549/files?skip=2&top=2" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json index a535279efbed..7c1afce096d1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -9,16 +11,16 @@ "body": { "values": [ { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", "contentUrls": [ "https://contoso.com/", "https://contoso2.com/" ], "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" }, "properties": { "diarizationEnabled": false, @@ -41,7 +43,39 @@ } } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=100&top=100" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json index af476903b5d9..9c69871f935e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" }, "responses": { "200": { @@ -25,6 +26,45 @@ "lastActionDateTime": "2018-11-28T00:00:00Z", "status": "Succeeded" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json index 5d3fec2933b4..00851c8e53c1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json @@ -1,7 +1,9 @@ { "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}" + "Ocp-Apim-Subscription-Key": "{API Key}", + "$skip": 0, + "$top": 10 }, "responses": { "200": { @@ -66,7 +68,39 @@ "status": "Succeeded" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks?skip=3&top=3" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks?skip=0&top=10" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json new file mode 100644 index 000000000000..a1c7899d951f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json new file mode 100644 index 000000000000..bca932b003cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {}, + "body": {} + }, + "204": { + "headers": {}, + "body": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json index de8bc3306860..1f5dbff0497e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json @@ -2,32 +2,76 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", "datasetUpdate": { "displayName": "Updated dataset name", "description": "Updated dataset description", "customProperties": { "key": "value" } - } + }, + "Content-Type": "application/json", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "responses": { "200": { "headers": {}, "body": { - "dataImportKind": "Acoustic", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, "lastActionDateTime": "2019-01-07T12:36:07Z", "status": "Succeeded", - "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", "createdDateTime": "2019-01-07T12:34:12Z", "locale": "en-US", - "name": "Acoustic dataset", - "properties": { - "AcceptedLines": "11", - "RejectedLines": "2", - "ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + "displayName": "Acoustic dataset" + } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." } } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json index 1e185d7032c3..d40e3f7cc000 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", "endpointUpdate": { "model": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" @@ -14,7 +14,8 @@ "customProperties": { "key": "value" } - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -22,7 +23,7 @@ "body": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", @@ -44,6 +45,45 @@ "displayName": "Speech endpoint", "description": "Example for speech endpoint" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json index 910bba41a627..a5b1928ab0be 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json @@ -2,11 +2,12 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", "evaluationUpdate": { "displayName": "Updated evaluation", "description": "Updated evaluation description" - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -17,16 +18,16 @@ "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, "model2": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "dataset": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" }, "transcription2": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" }, "transcription1": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" }, "links": { "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files" @@ -55,6 +56,45 @@ "locale": "en-US", "displayName": "Evalution of one model against another model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json index e7ba20572ab4..2f2a8ebd7041 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json @@ -2,20 +2,21 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", "modelUpdate": { "displayName": "Language model update", "description": "This is a language model update", "customProperties": { "key": "value" } - } + }, + "Content-Type": "application/json" }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b", "baseModel": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" }, @@ -25,8 +26,8 @@ } ], "links": { - "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037", - "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy" + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy" }, "properties": { "deprecationDates": { @@ -41,6 +42,45 @@ "displayName": "Language model", "description": "This is a language model" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json index 6172ff4f0a46..47c161313eef 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json @@ -2,13 +2,14 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "abc46f33-90b8-443d-adad-4870517356e0", "projectUpdate": { "displayName": "My updated speech project", "customProperties": { "key": "value" } - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -33,6 +34,45 @@ "locale": "en-US", "displayName": "My speech project" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json index f5f01991fb2b..0b2ca961d88f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json @@ -2,29 +2,30 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", "transcriptionUpdate": { "displayName": "Updated transcription name", "description": "Updated transcription description", "customProperties": { "key": "value" } - } + }, + "Content-Type": "application/json" }, "responses": { "200": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", "contentUrls": [ "https://contoso.com/", "https://contoso2.com/" ], "model": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037" + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" }, "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" }, "properties": { "diarizationEnabled": false, @@ -46,6 +47,45 @@ "key": "value" } } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json index e7c2d6a5ccea..e662a277d59c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "application/json", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d", "webHookUpdate": { "properties": { "secret": "SecretUsedToCreateHMACHexDigestThatYouWillFindIn\"X-MicrosoftSpeechServices-Signature\"HeaderWhenBeingCalledBack" @@ -19,7 +19,8 @@ "customProperties": { "key": "value" } - } + }, + "Content-Type": "application/json" }, "responses": { "200": { @@ -43,6 +44,45 @@ "lastActionDateTime": "2018-11-28T00:00:00Z", "status": "Succeeded" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "409": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json index 4f7b2912cf30..48f16eee06f3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -2,27 +2,25 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", + "project": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", "Content-Type": "multipart/form-data", - "form-data": { - "displayName": "My speech dataset name", - "description": "My speech dataset description", - "locale": "en-US", - "kind": "Acoustic", - "customProperties": { - "customProperty": "true" - }, - "email": "dataset@contoso.com" - } + "displayName": "My speech dataset name", + "description": "My speech dataset description", + "locale": "en-us", + "kind": "Acoustic", + "customProperties": "{ \"property\": \"true\" }", + "data": "multipart-form-data", + "email": "info@contoso.com" }, "responses": { - "200": { + "201": { "headers": {}, "body": { - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", "kind": "Acoustic", - "contentUrl": "https://www.example.org/acousticdata/sourcelocation", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", "links": { - "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93/files" + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" }, "properties": { "acceptedLineCount": 11, @@ -35,6 +33,45 @@ "locale": "en-US", "displayName": "Acoustic dataset" } + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "415": { + "headers": {}, + "body": { + "code": "UnsupportedMediaType", + "message": "The request entity's media type 'application/xml' is not supported for this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index f943382b9fb4..803833efb2d3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -32,12 +32,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -45,12 +39,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -58,12 +46,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -130,16 +112,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -147,12 +119,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -160,12 +126,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -173,12 +133,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -246,16 +200,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -263,12 +207,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -276,12 +214,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -289,12 +221,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -355,16 +281,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -372,12 +288,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -385,12 +295,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -398,12 +302,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -411,12 +309,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -488,16 +380,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -505,12 +387,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -518,12 +394,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "409": { @@ -531,12 +401,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -544,12 +408,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -599,16 +457,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -616,12 +464,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -629,12 +471,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -649,12 +485,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -669,7 +499,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } } }, "/datasets/upload": { @@ -757,16 +592,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -774,12 +599,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -787,12 +606,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "415": { @@ -800,12 +613,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "UnsupportedMediaType", - "message": "The request entity's media type 'application/xml' is not supported for this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -813,12 +620,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -908,12 +709,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -921,12 +716,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -934,12 +723,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -947,12 +730,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1033,12 +810,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1046,12 +817,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -1059,12 +824,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -1072,12 +831,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1125,12 +878,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1138,12 +885,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -1151,12 +892,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1230,12 +965,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1243,12 +972,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -1256,12 +979,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1329,16 +1046,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -1346,12 +1053,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1359,12 +1060,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -1372,12 +1067,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1445,12 +1134,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1458,12 +1141,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -1471,12 +1148,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -1484,12 +1155,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1539,16 +1204,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -1556,12 +1211,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1569,12 +1218,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -1582,12 +1225,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -1595,12 +1232,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1615,7 +1246,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete an endpoint": { + "$ref": "./examples/delete_endpoint.json" + } + } }, "patch": { "tags": [ @@ -1667,16 +1303,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -1684,12 +1310,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1697,12 +1317,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "409": { @@ -1710,12 +1324,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -1723,12 +1331,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1809,16 +1411,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -1826,12 +1418,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1839,12 +1425,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -1852,12 +1432,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -1865,12 +1439,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -1931,16 +1499,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -1948,12 +1506,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -1961,12 +1513,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -1974,12 +1520,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -1987,12 +1527,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2007,7 +1541,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete all endpoint logs": { + "$ref": "./examples/delete_endpoint_logs.json" + } + } } }, "/endpoints/{id}/files/logs/{logId}": { @@ -2056,16 +1595,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -2073,12 +1602,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2086,12 +1609,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -2099,12 +1616,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -2112,12 +1623,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2174,16 +1679,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -2191,12 +1686,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2204,12 +1693,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -2217,12 +1700,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -2230,12 +1707,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2250,7 +1721,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete an endpoint log": { + "$ref": "./examples/delete_endpoint_log.json" + } + } } }, "/endpoints/base/{locale}/files/logs": { @@ -2304,16 +1780,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -2321,12 +1787,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2334,12 +1794,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -2347,12 +1801,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -2360,12 +1808,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2425,16 +1867,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -2442,12 +1874,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2455,12 +1881,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -2468,12 +1888,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -2481,12 +1895,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2501,7 +1909,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete all base model logs": { + "$ref": "./examples/delete_base_model_logs.json" + } + } } }, "/endpoints/base/{locale}/files/logs/{logId}": { @@ -2549,16 +1962,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -2566,12 +1969,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2579,12 +1976,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -2592,12 +1983,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -2605,12 +1990,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2666,16 +2045,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -2683,12 +2052,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2696,12 +2059,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -2709,12 +2066,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -2722,12 +2073,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2742,7 +2087,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a base model log": { + "$ref": "./examples/delete_base_model_log.json" + } + } } }, "/evaluations/locales": { @@ -2770,12 +2120,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2783,12 +2127,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -2796,12 +2134,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2875,12 +2207,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2888,12 +2214,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -2901,12 +2221,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -2981,12 +2295,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -2994,12 +2302,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -3007,12 +2309,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3101,12 +2397,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3114,12 +2404,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -3127,12 +2411,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -3140,12 +2418,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3226,12 +2498,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3239,12 +2505,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -3252,12 +2512,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -3265,12 +2519,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3338,12 +2586,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3351,12 +2593,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -3364,12 +2600,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -3377,12 +2607,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3454,16 +2678,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -3471,12 +2685,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3484,12 +2692,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "409": { @@ -3497,12 +2699,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -3510,12 +2706,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3565,16 +2755,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -3582,12 +2762,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3595,12 +2769,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -3615,12 +2783,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3635,7 +2797,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a evaluation": { + "$ref": "./examples/delete_evaluation.json" + } + } } }, "/models/locales": { @@ -3663,12 +2830,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3676,12 +2837,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -3689,12 +2844,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3768,12 +2917,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3781,12 +2924,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -3794,12 +2931,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3867,16 +2998,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -3884,12 +3005,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3897,12 +3012,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -3910,12 +3019,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -3983,12 +3086,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -3996,12 +3093,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -4009,12 +3100,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4086,12 +3171,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4099,12 +3178,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -4112,12 +3185,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -4125,12 +3192,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4202,16 +3263,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -4219,12 +3270,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4232,12 +3277,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "409": { @@ -4245,12 +3284,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -4258,12 +3291,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4313,16 +3340,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -4330,12 +3347,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4343,12 +3354,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -4363,12 +3368,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4383,7 +3382,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a model": { + "$ref": "./examples/delete_model.jsom" + } + } } }, "/models/base/{id}": { @@ -4425,12 +3429,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4438,12 +3436,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -4451,12 +3443,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -4464,12 +3450,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4544,16 +3524,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -4561,12 +3531,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4574,12 +3538,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -4587,12 +3545,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -4600,12 +3552,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4665,17 +3611,7 @@ "400": { "description": "In case the operation cannot be performed successfully with the specified values.", "schema": { - "$ref": "#/definitions/Error" - }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } + "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, @@ -4684,12 +3620,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4697,12 +3627,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -4710,12 +3634,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -4723,12 +3641,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4790,16 +3702,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -4807,12 +3709,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4820,12 +3716,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -4833,12 +3723,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -4846,12 +3730,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4899,12 +3777,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -4912,12 +3784,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -4925,12 +3791,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -4998,12 +3858,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5011,12 +3865,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -5024,12 +3872,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5094,16 +3936,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -5111,12 +3943,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5124,12 +3950,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -5137,12 +3957,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5204,12 +4018,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5217,12 +4025,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -5230,12 +4032,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -5243,12 +4039,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5265,8 +4055,8 @@ } ], "x-ms-examples": { - "Get all projects": { - "$ref": "./examples/get_projects.json" + "Get a project": { + "$ref": "./examples/get_project.json" } } }, @@ -5314,16 +4104,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -5331,12 +4111,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5344,12 +4118,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "409": { @@ -5357,12 +4125,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -5370,12 +4132,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5425,16 +4181,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -5442,12 +4188,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5455,12 +4195,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -5475,12 +4209,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5495,7 +4223,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a project": { + "$ref": "./examples/delete_project.json" + } + } } }, "/projects/{id}/evaluations": { @@ -5550,16 +4283,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -5567,12 +4290,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5580,12 +4297,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -5593,12 +4304,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -5606,12 +4311,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5690,16 +4389,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -5707,12 +4396,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5720,12 +4403,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -5733,12 +4410,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -5746,12 +4417,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5830,16 +4495,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -5847,12 +4502,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -5860,12 +4509,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -5873,12 +4516,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -5886,12 +4523,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -5970,16 +4601,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -5987,12 +4608,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6000,12 +4615,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -6013,12 +4622,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -6026,12 +4629,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6110,16 +4707,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -6127,12 +4714,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6140,12 +4721,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -6153,12 +4728,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -6166,12 +4735,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6223,12 +4786,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6236,12 +4793,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -6249,12 +4800,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6328,12 +4873,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6341,12 +4880,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -6354,12 +4887,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6427,16 +4954,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -6444,12 +4961,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6457,12 +4968,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -6470,12 +4975,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6543,12 +5042,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6556,12 +5049,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -6569,12 +5056,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -6582,12 +5063,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6659,16 +5134,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -6676,12 +5141,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6689,12 +5148,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "409": { @@ -6702,12 +5155,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -6715,12 +5162,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6770,16 +5211,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -6787,12 +5218,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6800,12 +5225,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -6820,12 +5239,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -6840,7 +5253,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a transcription": { + "$ref": "./examples/delete_transcription.json" + } + } } }, "/transcriptions/{id}/files": { @@ -6909,12 +5327,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -6922,12 +5334,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -6935,12 +5341,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -6948,12 +5348,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7034,12 +5428,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7047,12 +5435,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -7060,12 +5442,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -7073,12 +5449,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7152,12 +5522,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7165,12 +5529,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -7178,12 +5536,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7249,16 +5601,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -7266,12 +5608,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7279,12 +5615,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "429": { @@ -7292,12 +5622,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7365,12 +5689,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7378,12 +5696,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -7391,12 +5703,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -7404,12 +5710,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7482,16 +5782,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -7499,12 +5789,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7512,12 +5796,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "409": { @@ -7525,12 +5803,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -7538,12 +5810,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7593,16 +5859,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, "x-ms-error-response": true }, "401": { @@ -7610,12 +5866,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7623,12 +5873,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -7643,12 +5887,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7663,7 +5901,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Delete a web hook": { + "$ref": "./examples/delete_web_hook.json" + } + } } }, "/webhooks/{id}/ping": { @@ -7714,12 +5957,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7727,12 +5964,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -7740,12 +5971,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -7753,12 +5978,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7777,6 +5996,11 @@ "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" + }, + "x-ms-examples": { + "Ping a web hook": { + "$ref": "./examples/ping_web_hook.json" + } } } }, @@ -7831,12 +6055,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, "x-ms-error-response": true }, "403": { @@ -7844,12 +6062,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, "x-ms-error-response": true }, "404": { @@ -7857,12 +6069,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, "x-ms-error-response": true }, "429": { @@ -7870,12 +6076,6 @@ "schema": { "$ref": "#/definitions/Error" }, - "examples": { - "application/json": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before not getting this response anymore.", @@ -7894,6 +6094,11 @@ "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" + }, + "x-ms-examples": { + "Test a web hook": { + "$ref": "./examples/test_web_hook.json" + } } } }, From b67d44beca44ba87aad76352df08ed1b2f99b98c Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 18:01:41 +0100 Subject: [PATCH 25/34] Fix file name --- .../v2.0/examples/{delete_model.jsom => delete_model.json} | 0 .../Speech/SpeechToText/stable/v2.0/speechtotext.json | 2 +- .../v3.0/examples/{delete_model.jsom => delete_model.json} | 0 .../Speech/SpeechToText/stable/v3.0/speechtotext.json | 2 +- 4 files changed, 2 insertions(+), 2 deletions(-) rename specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/{delete_model.jsom => delete_model.json} (100%) rename specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/{delete_model.jsom => delete_model.json} (100%) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json similarity index 100% rename from specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom rename to specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index 4cb1c6e611b7..ed81f21c1a9d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -3997,7 +3997,7 @@ ], "x-ms-examples": { "Delete a model": { - "$ref": "./examples/delete_model.jsom" + "$ref": "./examples/delete_model.json" } } } diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json similarity index 100% rename from specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom rename to specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 803833efb2d3..16332e91f1bf 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -3385,7 +3385,7 @@ ], "x-ms-examples": { "Delete a model": { - "$ref": "./examples/delete_model.jsom" + "$ref": "./examples/delete_model.json" } } } From b3fedef8c04b404397e72204c74c10712b01feee Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 18:16:08 +0100 Subject: [PATCH 26/34] Fix 204 response body --- .../v2.0/examples/create_accuracy_test.json | 2 +- .../stable/v2.0/examples/create_endpoint.json | 2 +- .../create_endpoint_data_exports.json | 2 +- .../stable/v2.0/examples/create_model.json | 2 +- .../v2.0/examples/create_transcription.json | 2 +- .../v2.0/examples/delete_accuracy_test.json | 5 +- .../stable/v2.0/examples/delete_dataset.json | 5 +- .../stable/v2.0/examples/delete_endpoint.json | 5 +- .../v2.0/examples/delete_endpoint_data.json | 5 +- .../examples/delete_endpoint_data_export.json | 5 +- .../stable/v2.0/examples/delete_model.jsom | 40 +++++++++++++++ .../v2.0/examples/delete_transcription.json | 5 +- .../v2.0/examples/get_accuracy_test.json | 2 +- .../v2.0/examples/get_accuracy_tests.json | 2 +- .../stable/v2.0/examples/get_dataset.json | 2 +- .../stable/v2.0/examples/get_datasets.json | 2 +- .../stable/v2.0/examples/get_endpoint.json | 2 +- .../examples/get_endpoint_data_export.json | 2 +- .../examples/get_endpoint_data_exports.json | 2 +- .../stable/v2.0/examples/get_endpoints.json | 2 +- .../stable/v2.0/examples/get_model.json | 2 +- .../stable/v2.0/examples/get_models.json | 2 +- .../get_supported_dataset_locales.json | 2 +- .../get_supported_endpoint_locales.json | 2 +- .../examples/get_supported_model_locales.json | 2 +- .../get_supported_transcription_locales.json | 2 +- .../v2.0/examples/get_transcription.json | 2 +- .../v2.0/examples/get_transcriptions.json | 2 +- .../v2.0/examples/update_accuracy_test.json | 2 +- .../stable/v2.0/examples/update_dataset.json | 2 +- .../stable/v2.0/examples/update_endpoint.json | 2 +- .../stable/v2.0/examples/update_model.json | 2 +- .../v2.0/examples/update_transcription.json | 2 +- .../stable/v2.0/examples/upload_dataset.json | 5 +- .../stable/v3.0/examples/copy_model.json | 2 +- .../stable/v3.0/examples/create_dataset.json | 2 +- .../stable/v3.0/examples/create_endpoint.json | 2 +- .../v3.0/examples/create_evaluation.json | 2 +- .../stable/v3.0/examples/create_model.json | 2 +- .../stable/v3.0/examples/create_project.json | 2 +- .../v3.0/examples/create_transcription.json | 2 +- .../stable/v3.0/examples/create_web_hook.json | 2 +- .../v3.0/examples/delete_base_model_log.json | 5 +- .../v3.0/examples/delete_base_model_logs.json | 5 +- .../stable/v3.0/examples/delete_dataset.json | 5 +- .../stable/v3.0/examples/delete_endpoint.json | 5 +- .../v3.0/examples/delete_endpoint_log.json | 5 +- .../v3.0/examples/delete_endpoint_logs.json | 5 +- .../v3.0/examples/delete_evaluation.json | 5 +- .../stable/v3.0/examples/delete_model.jsom | 51 +++++++++++++++++++ .../stable/v3.0/examples/delete_project.json | 5 +- .../v3.0/examples/delete_transcription.json | 5 +- .../stable/v3.0/examples/delete_web_hook.json | 5 +- .../stable/v3.0/examples/get_base_model.json | 2 +- .../v3.0/examples/get_base_model_log.json | 2 +- .../v3.0/examples/get_base_model_logs.json | 2 +- .../examples/get_base_model_manifest.json | 2 +- .../stable/v3.0/examples/get_base_models.json | 2 +- .../stable/v3.0/examples/get_dataset.json | 2 +- .../v3.0/examples/get_dataset_file.json | 2 +- .../v3.0/examples/get_dataset_files.json | 2 +- .../stable/v3.0/examples/get_datasets.json | 2 +- .../stable/v3.0/examples/get_endpoint.json | 2 +- .../v3.0/examples/get_endpoint_log.json | 2 +- .../v3.0/examples/get_endpoint_logs.json | 2 +- .../stable/v3.0/examples/get_endpoints.json | 2 +- .../stable/v3.0/examples/get_evaluation.json | 2 +- .../v3.0/examples/get_evaluation_file.json | 2 +- .../v3.0/examples/get_evaluation_files.json | 2 +- .../stable/v3.0/examples/get_evaluations.json | 2 +- .../stable/v3.0/examples/get_model.json | 2 +- .../v3.0/examples/get_model_manifest.json | 2 +- .../stable/v3.0/examples/get_models.json | 2 +- .../stable/v3.0/examples/get_project.json | 2 +- .../v3.0/examples/get_project_datasets.json | 2 +- .../v3.0/examples/get_project_endpoints.json | 2 +- .../examples/get_project_evaluations.json | 2 +- .../v3.0/examples/get_project_models.json | 2 +- .../examples/get_project_transcriptions.json | 2 +- .../stable/v3.0/examples/get_projects.json | 2 +- .../get_supported_dataset_locales.json | 2 +- .../get_supported_endpoint_locales.json | 2 +- .../get_supported_evaluations_locales.json | 2 +- .../examples/get_supported_model_locales.json | 2 +- .../get_supported_project_locales.json | 2 +- .../get_supported_transcription_locales.json | 2 +- .../v3.0/examples/get_transcription.json | 2 +- .../v3.0/examples/get_transcription_file.json | 2 +- .../examples/get_transcription_files.json | 2 +- .../v3.0/examples/get_transcriptions.json | 2 +- .../stable/v3.0/examples/get_web_hook.json | 2 +- .../stable/v3.0/examples/get_web_hooks.json | 2 +- .../stable/v3.0/examples/ping_web_hook.json | 5 +- .../stable/v3.0/examples/test_web_hook.json | 8 ++- .../stable/v3.0/examples/update_dataset.json | 2 +- .../stable/v3.0/examples/update_endpoint.json | 2 +- .../v3.0/examples/update_evaluation.json | 2 +- .../stable/v3.0/examples/update_model.json | 2 +- .../stable/v3.0/examples/update_project.json | 2 +- .../v3.0/examples/update_transcription.json | 2 +- .../stable/v3.0/examples/update_web_hook.json | 2 +- .../stable/v3.0/examples/upload_dataset.json | 2 +- 102 files changed, 211 insertions(+), 140 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json index 9bc9ce00b979..86960a0d808d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json @@ -42,4 +42,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json index c7ad33ed57be..63e501188826 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json @@ -46,4 +46,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json index ae7a3035a0d0..a400cb56d6da 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json @@ -46,4 +46,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json index 5b8263d03524..a07d10684eb1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json @@ -48,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json index 13e8be76511e..b6d4ac161677 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json @@ -48,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json index f4a5d25d771d..8697171f2cdd 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "401": { "headers": {}, @@ -31,4 +30,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json index 8c7c0729aac6..eedae5f3e43d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -38,4 +37,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json index 016d7c42caf6..49bb5f4a95de 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "401": { "headers": {}, @@ -31,4 +30,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json index a513b703ab17..f142dfeede85 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "401": { "headers": {}, @@ -31,4 +30,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json index 9d7b4ef0e6e5..108d051036e3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json @@ -7,8 +7,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -39,4 +38,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom new file mode 100644 index 000000000000..546850abab4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "BadRequest", + "message": "The request has been incorrect." + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json index 5f0814b0f9bc..a7c3c8da95be 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -38,4 +37,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json index c836c7b3e810..b1e6150088ef 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json @@ -125,4 +125,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json index 0946c13b8a19..c8b7ccf34f73 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json @@ -119,4 +119,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json index f30f112057da..6672c32032d8 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json @@ -51,4 +51,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json index 1534811bb997..6814e50c2917 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json @@ -73,4 +73,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json index ce9aa549e1a4..b228e7943880 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json @@ -117,4 +117,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json index c7a2bbf02745..5167f01f0090 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json @@ -47,4 +47,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json index 6c6c78757947..f091bd132407 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json @@ -48,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json index 95c8dd37b8d4..e11699def497 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json @@ -111,4 +111,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json index 8fd2f2a3809a..0949ff2177c7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json @@ -74,4 +74,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json index 3fac3cba7299..47ca1d080c78 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json @@ -94,4 +94,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json index 11005cadb75d..170b93b6d768 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json @@ -41,4 +41,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json index a65ac640c9ec..e68c489eb11f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json @@ -33,4 +33,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json index 200b0762d0ae..ccd5f3fceae5 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json @@ -38,4 +38,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json index a65ac640c9ec..e68c489eb11f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json @@ -33,4 +33,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json index 0dd12dda929a..a3aaf3fe241d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json @@ -121,4 +121,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json index 7516d4320d80..e84da53dc485 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json @@ -115,4 +115,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json index 2626dfc7e8d1..3e0fd623a691 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json @@ -137,4 +137,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json index efdbcebac377..d1dfe266045c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json @@ -63,4 +63,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json index dd9cf46bb0c4..854a1e67934a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json @@ -129,4 +129,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json index 49bb4f0d9a2f..682ac57b9dfb 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json @@ -86,4 +86,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json index b2b0168dded3..2a85b49aeabb 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json @@ -133,4 +133,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json index 0c77eebe950a..7ad9a5467120 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json @@ -14,8 +14,7 @@ }, "responses": { "202": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -53,4 +52,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json index 80a7eaf783fe..d05ba68cc0f6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json @@ -79,4 +79,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json index 1a32cdc6907b..3e0921b99b5c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json @@ -66,4 +66,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json index 1bbf198d660a..cc5d6ce4b56e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json @@ -77,4 +77,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json index d10a6791ac50..63c8b524706d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json @@ -99,4 +99,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json index 55b1d1f6c98f..9c4a8d380d66 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json @@ -83,4 +83,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json index ae70359d9a72..3ebcf730e207 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json @@ -65,4 +65,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json index 9c1ee6474499..37b09b5502cb 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json @@ -87,4 +87,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json index d6daca7eedd2..a4d738e08027 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json @@ -71,4 +71,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json index 1cd287a4f3a9..66f3c306ea06 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json @@ -7,8 +7,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -50,4 +49,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json index e87251d80ed3..97eba679e3af 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json @@ -7,8 +7,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -50,4 +49,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json index 7d07e11cb8e8..877e67d767b3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json index 41843acdaef3..19686188c866 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json index 6c28a83ea685..4d1288fbbf2b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json @@ -7,8 +7,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -50,4 +49,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json index c06ee4cf2ab4..2be55013fc49 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json @@ -7,8 +7,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -50,4 +49,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json index 203e82712d6b..b7ac6430ac94 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom new file mode 100644 index 000000000000..15b1775412a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + }, + "400": { + "headers": {}, + "body": { + "code": "InvalidRequest", + "message": "The base model isn't valid for this operation.", + "innerError": { + "code": "InvalidBaseModel", + "message": "The base model isn't valid for this operation." + } + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "404": { + "headers": {}, + "body": { + "code": "NotFound", + "message": "The specified entity cannot be found." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json index 6f0ac322c53b..704317467a38 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json index 2dce0832ee87..630d28bcbfc4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json index a842e83b2ba4..76598330b2b0 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json index 9bea763bf362..0af2a8f5dc1d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json @@ -65,4 +65,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json index 8841c8c3fe78..b0e65dd21200 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json @@ -62,4 +62,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json index 90da33828e38..e2ba8cc6aa60 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json @@ -80,4 +80,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json index bc104cf762a6..616043a32c4b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json @@ -89,4 +89,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json index 3a59f60963da..daf7cb537aea 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json @@ -81,4 +81,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json index 5ae01638b0bc..093b4c11b491 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json @@ -66,4 +66,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json index f4212dcc2277..c027e7cf48e3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json @@ -62,4 +62,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json index f1ba30e215dd..eab092ef7591 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json @@ -81,4 +81,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json index 66918b6d761e..6f54ab929a19 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json @@ -103,4 +103,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json index f46b912e0a50..6f25abb4f96c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json @@ -73,4 +73,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json index 3aa8f14a5c40..7cb60939499c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json @@ -62,4 +62,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json index 363fd53e7023..413954545962 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json @@ -80,4 +80,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json index 00851c8e53c1..f7168d835cd7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json @@ -104,4 +104,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json index 5538b3404b22..5c563a06777b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json @@ -92,4 +92,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json index 0cc218837ed2..0f6d41773ab9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json @@ -62,4 +62,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json index 33181fd0550a..3c9d4a83a045 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json @@ -80,4 +80,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json index 2e96aeb25bd9..628c71c854d3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json @@ -179,4 +179,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json index 3b09e852b75a..fc81ffbe2af6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json @@ -75,4 +75,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json index bc104cf762a6..616043a32c4b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json @@ -89,4 +89,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json index 80409084589a..79607fed0274 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json @@ -101,4 +101,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json index 006fb32cf234..10c942a3b953 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json @@ -68,4 +68,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json index 9668663797fe..3e90b209c510 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json @@ -111,4 +111,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json index 8a706c722441..b891f3825580 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json @@ -130,4 +130,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json index 37a7a1f9f1ab..d1871045df83 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json @@ -187,4 +187,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json index a73bcd8550ea..3da7827ccdd2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json @@ -109,4 +109,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json index c8de29e03298..0791c0296666 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json @@ -87,4 +87,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json index ce42e5aefabc..d1606fe50e7a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json @@ -107,4 +107,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json index b910b5b5f1b7..f70210ea32ed 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json @@ -41,4 +41,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json index a65ac640c9ec..e68c489eb11f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json @@ -33,4 +33,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json index a65ac640c9ec..e68c489eb11f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json @@ -33,4 +33,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json index a65ac640c9ec..e68c489eb11f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json @@ -33,4 +33,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json index a65ac640c9ec..e68c489eb11f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json @@ -33,4 +33,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json index a65ac640c9ec..e68c489eb11f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json @@ -33,4 +33,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json index 7a72fb77b45b..b0ff3f3a9bae 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json @@ -80,4 +80,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json index f59eaac60925..877823c952b9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json @@ -62,4 +62,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json index d7e9e1f2582c..dd3dae649205 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json @@ -80,4 +80,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json index 7c1afce096d1..4ee48870de19 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json @@ -79,4 +79,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json index 9c69871f935e..1303be40753c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json @@ -67,4 +67,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json index 00851c8e53c1..f7168d835cd7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json @@ -104,4 +104,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json index a1c7899d951f..113f7d75eafd 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json @@ -6,8 +6,7 @@ }, "responses": { "202": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json index bca932b003cc..0768487d2dea 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json @@ -6,12 +6,10 @@ }, "responses": { "202": { - "headers": {}, - "body": {} + "headers": {} }, "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -53,4 +51,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json index 1f5dbff0497e..1bbd1c0d83ed 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json @@ -74,4 +74,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json index d40e3f7cc000..84aef0153770 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json @@ -86,4 +86,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json index a5b1928ab0be..e1d23b6c1e6e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json @@ -97,4 +97,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json index 2f2a8ebd7041..eb59f511d365 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json @@ -83,4 +83,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json index 47c161313eef..1740ec647174 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json @@ -75,4 +75,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json index 0b2ca961d88f..f18d9c422fb1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json @@ -88,4 +88,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json index e662a277d59c..c95675e9e21a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json @@ -85,4 +85,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json index 48f16eee06f3..c2c261d753cd 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -74,4 +74,4 @@ } } } -} +} \ No newline at end of file From b06a349c4a2cd15e29732cb7ad06c279c52d4dc3 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 19:16:07 +0100 Subject: [PATCH 27/34] more fixes and prettier --- .../v2.0/examples/create_accuracy_test.json | 2 +- .../stable/v2.0/examples/create_endpoint.json | 5 +- .../create_endpoint_data_exports.json | 5 +- .../stable/v2.0/examples/create_model.json | 5 +- .../v2.0/examples/create_transcription.json | 2 +- .../v2.0/examples/delete_accuracy_test.json | 2 +- .../stable/v2.0/examples/delete_dataset.json | 2 +- .../stable/v2.0/examples/delete_endpoint.json | 2 +- .../v2.0/examples/delete_endpoint_data.json | 2 +- .../examples/delete_endpoint_data_export.json | 2 +- .../stable/v2.0/examples/delete_model.json | 5 +- .../v2.0/examples/delete_transcription.json | 2 +- .../v2.0/examples/get_accuracy_test.json | 2 +- .../v2.0/examples/get_accuracy_tests.json | 2 +- .../stable/v2.0/examples/get_dataset.json | 2 +- .../stable/v2.0/examples/get_datasets.json | 2 +- .../stable/v2.0/examples/get_endpoint.json | 2 +- .../examples/get_endpoint_data_export.json | 2 +- .../examples/get_endpoint_data_exports.json | 2 +- .../stable/v2.0/examples/get_endpoints.json | 2 +- .../stable/v2.0/examples/get_model.json | 2 +- .../stable/v2.0/examples/get_models.json | 2 +- .../get_supported_dataset_locales.json | 2 +- .../get_supported_endpoint_locales.json | 2 +- .../examples/get_supported_model_locales.json | 2 +- .../get_supported_transcription_locales.json | 2 +- .../v2.0/examples/get_transcription.json | 2 +- .../v2.0/examples/get_transcriptions.json | 2 +- .../v2.0/examples/update_accuracy_test.json | 2 +- .../stable/v2.0/examples/update_dataset.json | 2 +- .../stable/v2.0/examples/update_endpoint.json | 2 +- .../stable/v2.0/examples/update_model.json | 2 +- .../v2.0/examples/update_transcription.json | 2 +- .../stable/v2.0/examples/upload_dataset.json | 2 +- .../stable/v3.0/examples/copy_model.json | 2 +- .../stable/v3.0/examples/create_dataset.json | 2 +- .../stable/v3.0/examples/create_endpoint.json | 4 +- .../v3.0/examples/create_evaluation.json | 4 +- .../stable/v3.0/examples/create_model.json | 2 +- .../stable/v3.0/examples/create_project.json | 2 +- .../v3.0/examples/create_transcription.json | 2 +- .../stable/v3.0/examples/create_web_hook.json | 2 +- .../v3.0/examples/delete_base_model_log.json | 2 +- .../v3.0/examples/delete_base_model_logs.json | 4 +- .../stable/v3.0/examples/delete_dataset.json | 2 +- .../stable/v3.0/examples/delete_endpoint.json | 2 +- .../v3.0/examples/delete_endpoint_log.json | 2 +- .../v3.0/examples/delete_endpoint_logs.json | 4 +- .../v3.0/examples/delete_evaluation.json | 2 +- .../stable/v3.0/examples/delete_model.json | 5 +- .../stable/v3.0/examples/delete_project.json | 2 +- .../v3.0/examples/delete_transcription.json | 2 +- .../stable/v3.0/examples/delete_web_hook.json | 2 +- .../stable/v3.0/examples/get_base_model.json | 2 +- .../v3.0/examples/get_base_model_log.json | 2 +- .../v3.0/examples/get_base_model_logs.json | 2 +- .../examples/get_base_model_manifest.json | 2 +- .../stable/v3.0/examples/get_base_models.json | 2 +- .../stable/v3.0/examples/get_dataset.json | 2 +- .../v3.0/examples/get_dataset_file.json | 2 +- .../v3.0/examples/get_dataset_files.json | 2 +- .../stable/v3.0/examples/get_datasets.json | 2 +- .../stable/v3.0/examples/get_endpoint.json | 2 +- .../v3.0/examples/get_endpoint_log.json | 2 +- .../v3.0/examples/get_endpoint_logs.json | 2 +- .../stable/v3.0/examples/get_endpoints.json | 100 +++++++++++------- .../stable/v3.0/examples/get_evaluation.json | 2 +- .../v3.0/examples/get_evaluation_file.json | 2 +- .../v3.0/examples/get_evaluation_files.json | 2 +- .../stable/v3.0/examples/get_evaluations.json | 2 +- .../stable/v3.0/examples/get_model.json | 2 +- .../v3.0/examples/get_model_manifest.json | 2 +- .../stable/v3.0/examples/get_models.json | 2 +- .../stable/v3.0/examples/get_project.json | 2 +- .../v3.0/examples/get_project_datasets.json | 2 +- .../v3.0/examples/get_project_endpoints.json | 2 +- .../examples/get_project_evaluations.json | 2 +- .../v3.0/examples/get_project_models.json | 2 +- .../examples/get_project_transcriptions.json | 2 +- .../stable/v3.0/examples/get_projects.json | 2 +- .../get_supported_dataset_locales.json | 2 +- .../get_supported_endpoint_locales.json | 2 +- .../get_supported_evaluations_locales.json | 2 +- .../examples/get_supported_model_locales.json | 2 +- .../get_supported_project_locales.json | 2 +- .../get_supported_transcription_locales.json | 2 +- .../v3.0/examples/get_transcription.json | 2 +- .../v3.0/examples/get_transcription_file.json | 2 +- .../examples/get_transcription_files.json | 2 +- .../v3.0/examples/get_transcriptions.json | 2 +- .../stable/v3.0/examples/get_web_hook.json | 2 +- .../stable/v3.0/examples/get_web_hooks.json | 2 +- .../stable/v3.0/examples/ping_web_hook.json | 2 +- .../stable/v3.0/examples/test_web_hook.json | 2 +- .../stable/v3.0/examples/update_dataset.json | 2 +- .../stable/v3.0/examples/update_endpoint.json | 2 +- .../v3.0/examples/update_evaluation.json | 2 +- .../stable/v3.0/examples/update_model.json | 2 +- .../stable/v3.0/examples/update_project.json | 2 +- .../v3.0/examples/update_transcription.json | 2 +- .../stable/v3.0/examples/update_web_hook.json | 2 +- .../stable/v3.0/examples/upload_dataset.json | 2 +- .../stable/v3.0/speechtotext.json | 6 ++ 103 files changed, 181 insertions(+), 150 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json index 86960a0d808d..9bc9ce00b979 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json @@ -42,4 +42,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json index 63e501188826..ee2d13154fb6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json @@ -17,6 +17,9 @@ "Content-Type": "application/json" }, "responses": { + "202": { + "headers": {} + }, "400": { "headers": {}, "body": { @@ -46,4 +49,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json index a400cb56d6da..1a69056a1d0e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json @@ -10,6 +10,9 @@ "Content-Type": "application/json" }, "responses": { + "202": { + "headers": {} + }, "400": { "headers": {}, "body": { @@ -46,4 +49,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json index a07d10684eb1..4e0280838aa1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json @@ -19,6 +19,9 @@ "Content-Type": "application/json" }, "responses": { + "202": { + "headers": {} + }, "400": { "headers": {}, "body": { @@ -48,4 +51,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json index b6d4ac161677..13e8be76511e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json index 8697171f2cdd..6a23ec68bb10 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json @@ -30,4 +30,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json index eedae5f3e43d..d1baf9a62850 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json index 49bb5f4a95de..5b48ffeff607 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json @@ -30,4 +30,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json index f142dfeede85..c49f415cdae2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json @@ -30,4 +30,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json index 108d051036e3..5dd8874d89e4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json @@ -38,4 +38,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json index 9e252b60e162..bc37f17e93a5 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -38,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json index a7c3c8da95be..9c36f0caaa9d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_transcription.json @@ -37,4 +37,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json index b1e6150088ef..c836c7b3e810 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_test.json @@ -125,4 +125,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json index c8b7ccf34f73..0946c13b8a19 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_accuracy_tests.json @@ -119,4 +119,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json index 6672c32032d8..f30f112057da 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_dataset.json @@ -51,4 +51,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json index 6814e50c2917..1534811bb997 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_datasets.json @@ -73,4 +73,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json index b228e7943880..ce9aa549e1a4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint.json @@ -117,4 +117,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json index 5167f01f0090..c7a2bbf02745 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_export.json @@ -47,4 +47,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json index f091bd132407..6c6c78757947 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoint_data_exports.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json index e11699def497..95c8dd37b8d4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_endpoints.json @@ -111,4 +111,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json index 0949ff2177c7..8fd2f2a3809a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_model.json @@ -74,4 +74,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json index 47ca1d080c78..3fac3cba7299 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_models.json @@ -94,4 +94,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json index 170b93b6d768..11005cadb75d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_dataset_locales.json @@ -41,4 +41,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json index e68c489eb11f..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_endpoint_locales.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json index ccd5f3fceae5..200b0762d0ae 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_model_locales.json @@ -38,4 +38,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json index e68c489eb11f..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_supported_transcription_locales.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json index a3aaf3fe241d..0dd12dda929a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcription.json @@ -121,4 +121,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json index e84da53dc485..7516d4320d80 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/get_transcriptions.json @@ -115,4 +115,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json index 3e0fd623a691..2626dfc7e8d1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_accuracy_test.json @@ -137,4 +137,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json index d1dfe266045c..efdbcebac377 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_dataset.json @@ -63,4 +63,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json index 854a1e67934a..dd9cf46bb0c4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_endpoint.json @@ -129,4 +129,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json index 682ac57b9dfb..49bb4f0d9a2f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_model.json @@ -86,4 +86,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json index 2a85b49aeabb..b2b0168dded3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/update_transcription.json @@ -133,4 +133,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json index 7ad9a5467120..fec20f8de7cc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json @@ -52,4 +52,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json index d05ba68cc0f6..80a7eaf783fe 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/copy_model.json @@ -79,4 +79,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json index 3e0921b99b5c..1a32cdc6907b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_dataset.json @@ -66,4 +66,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json index cc5d6ce4b56e..49eb3a6574bc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_endpoint.json @@ -16,7 +16,7 @@ "Content-Type": "application/json" }, "responses": { - "200": { + "201": { "headers": {}, "body": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", @@ -77,4 +77,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json index 63c8b524706d..f80f6307002b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_evaluation.json @@ -19,7 +19,7 @@ "Content-Type": "application/json" }, "responses": { - "200": { + "201": { "headers": {}, "body": { "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", @@ -99,4 +99,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json index 9c4a8d380d66..55b1d1f6c98f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_model.json @@ -83,4 +83,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json index 3ebcf730e207..ae70359d9a72 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_project.json @@ -65,4 +65,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json index 37b09b5502cb..9c1ee6474499 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_transcription.json @@ -87,4 +87,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json index a4d738e08027..d6daca7eedd2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json @@ -71,4 +71,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json index 66f3c306ea06..38d4ca0605e4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_log.json @@ -49,4 +49,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json index 97eba679e3af..55c86a5d8bc5 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_base_model_logs.json @@ -6,7 +6,7 @@ "endDate": "2019-01-01" }, "responses": { - "204": { + "202": { "headers": {} }, "400": { @@ -49,4 +49,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json index 877e67d767b3..61e6ed96c2a2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_dataset.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json index 19686188c866..9f0c26d3fa18 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json index 4d1288fbbf2b..233c71c13736 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_log.json @@ -49,4 +49,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json index 2be55013fc49..ff96518fa82f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_endpoint_logs.json @@ -6,7 +6,7 @@ "endDate": "2019-01-01" }, "responses": { - "204": { + "202": { "headers": {} }, "400": { @@ -49,4 +49,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json index b7ac6430ac94..d7f856b0d1eb 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_evaluation.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json index 11ce645b5b73..f20a60c2e2a4 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.json @@ -6,8 +6,7 @@ }, "responses": { "204": { - "headers": {}, - "body": {} + "headers": {} }, "400": { "headers": {}, @@ -49,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json index 704317467a38..f625f38bd696 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_project.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json index 630d28bcbfc4..8a122f914a0c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_transcription.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json index 76598330b2b0..e3f3377f9c4c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_web_hook.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json index 0af2a8f5dc1d..9bea763bf362 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model.json @@ -65,4 +65,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json index b0e65dd21200..8841c8c3fe78 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_log.json @@ -62,4 +62,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json index e2ba8cc6aa60..90da33828e38 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_logs.json @@ -80,4 +80,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json index 616043a32c4b..bc104cf762a6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_model_manifest.json @@ -89,4 +89,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json index daf7cb537aea..3a59f60963da 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_base_models.json @@ -81,4 +81,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json index 093b4c11b491..5ae01638b0bc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset.json @@ -66,4 +66,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json index c027e7cf48e3..f4212dcc2277 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_file.json @@ -62,4 +62,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json index eab092ef7591..f1ba30e215dd 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_dataset_files.json @@ -81,4 +81,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json index 6f54ab929a19..66918b6d761e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_datasets.json @@ -103,4 +103,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json index 6f25abb4f96c..f46b912e0a50 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint.json @@ -73,4 +73,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json index 7cb60939499c..3aa8f14a5c40 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_log.json @@ -62,4 +62,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json index 413954545962..363fd53e7023 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoint_logs.json @@ -80,4 +80,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json index f7168d835cd7..aeab2ba8044f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_endpoints.json @@ -11,64 +11,82 @@ "body": { "values": [ { - "displayName": "TranscriptionCompletionWebHook", - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, "links": { - "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", - "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" }, "properties": { - "apiVersion": "v3.0" - }, - "webUrl": "https://contoso.com/call/me/back", - "events": { - "transcriptionCompletion": true + "timeToLive": "PT30M", + "loggingEnabled": true }, - "description": "I registered this URL to get a POST request for each completed transcription.", - "createdDateTime": "2018-11-11T00:00:00Z", - "lastActionDateTime": "2018-11-28T00:00:00Z", - "status": "Succeeded" + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" }, { - "displayName": "TranscriptionCompletionWebHook", - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, "links": { - "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", - "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" }, "properties": { - "apiVersion": "v3.0" + "timeToLive": "PT30M", + "loggingEnabled": true }, - "webUrl": "https://contoso.com/call/me/back", - "events": { - "transcriptionCompletion": true - }, - "description": "I registered this URL to get a POST request for each completed transcription.", - "createdDateTime": "2018-11-11T00:00:00Z", - "lastActionDateTime": "2018-11-28T00:00:00Z", - "status": "Succeeded" + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" }, { - "displayName": "TranscriptionCompletionWebHook", - "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/034034ec-2872-43e0-b1e5-f57735e253bf", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, "links": { - "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test", - "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping" + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" }, "properties": { - "apiVersion": "v3.0" - }, - "webUrl": "https://contoso.com/call/me/back", - "events": { - "transcriptionCompletion": true + "timeToLive": "PT30M", + "loggingEnabled": false }, - "description": "I registered this URL to get a POST request for each completed transcription.", - "createdDateTime": "2018-11-11T00:00:00Z", - "lastActionDateTime": "2018-11-28T00:00:00Z", - "status": "Succeeded" + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" } ], - "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks?skip=0&top=10" + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints?skip=0&top=10" } }, "400": { @@ -104,4 +122,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json index 5c563a06777b..5538b3404b22 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation.json @@ -92,4 +92,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json index 0f6d41773ab9..0cc218837ed2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_file.json @@ -62,4 +62,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json index 3c9d4a83a045..33181fd0550a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluation_files.json @@ -80,4 +80,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json index 628c71c854d3..2e96aeb25bd9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_evaluations.json @@ -179,4 +179,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json index fc81ffbe2af6..3b09e852b75a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model.json @@ -75,4 +75,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json index 616043a32c4b..bc104cf762a6 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_model_manifest.json @@ -89,4 +89,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json index 79607fed0274..80409084589a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_models.json @@ -101,4 +101,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json index 10c942a3b953..006fb32cf234 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project.json @@ -68,4 +68,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json index 3e90b209c510..9668663797fe 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_datasets.json @@ -111,4 +111,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json index b891f3825580..8a706c722441 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_endpoints.json @@ -130,4 +130,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json index d1871045df83..37a7a1f9f1ab 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_evaluations.json @@ -187,4 +187,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json index 3da7827ccdd2..a73bcd8550ea 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_models.json @@ -109,4 +109,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json index 0791c0296666..c8de29e03298 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_project_transcriptions.json @@ -87,4 +87,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json index d1606fe50e7a..ce42e5aefabc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_projects.json @@ -107,4 +107,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json index f70210ea32ed..b910b5b5f1b7 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_dataset_locales.json @@ -41,4 +41,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json index e68c489eb11f..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_endpoint_locales.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json index e68c489eb11f..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_evaluations_locales.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json index e68c489eb11f..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_model_locales.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json index e68c489eb11f..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_project_locales.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json index e68c489eb11f..a65ac640c9ec 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_supported_transcription_locales.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json index b0ff3f3a9bae..7a72fb77b45b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription.json @@ -80,4 +80,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json index 877823c952b9..f59eaac60925 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_file.json @@ -62,4 +62,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json index dd3dae649205..d7e9e1f2582c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcription_files.json @@ -80,4 +80,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json index 4ee48870de19..7c1afce096d1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_transcriptions.json @@ -79,4 +79,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json index 1303be40753c..9c69871f935e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hook.json @@ -67,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json index f7168d835cd7..00851c8e53c1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_web_hooks.json @@ -104,4 +104,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json index 113f7d75eafd..b9200fe97a13 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/ping_web_hook.json @@ -48,4 +48,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json index 0768487d2dea..db331fdce132 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/test_web_hook.json @@ -51,4 +51,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json index 1bbd1c0d83ed..1f5dbff0497e 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_dataset.json @@ -74,4 +74,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json index 84aef0153770..d40e3f7cc000 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_endpoint.json @@ -86,4 +86,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json index e1d23b6c1e6e..a5b1928ab0be 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_evaluation.json @@ -97,4 +97,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json index eb59f511d365..2f2a8ebd7041 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_model.json @@ -83,4 +83,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json index 1740ec647174..47c161313eef 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_project.json @@ -75,4 +75,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json index f18d9c422fb1..0b2ca961d88f 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_transcription.json @@ -88,4 +88,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json index c95675e9e21a..e662a277d59c 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json @@ -85,4 +85,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json index c2c261d753cd..48f16eee06f3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -74,4 +74,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 16332e91f1bf..53e8aa63bbee 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -3923,6 +3923,9 @@ "responses": { "201": { "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/Project" + }, "headers": { "Location": { "description": "The location of the created resource.", @@ -5588,6 +5591,9 @@ "responses": { "201": { "description": "The response contains the location of the entity as header.", + "schema": { + "$ref": "#/definitions/WebHook" + }, "headers": { "Location": { "description": "The location of the created resource.", From f071c461d700691ba672b74d35b2a8b75b85a704 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 19:38:46 +0100 Subject: [PATCH 28/34] Fix response example --- .../v2.0/examples/create_transcription.json | 87 +++++++++++++++++++ 1 file changed, 87 insertions(+) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json index 13e8be76511e..d396461de0d3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json @@ -19,6 +19,93 @@ "Content-Type": "application/json" }, "responses": { + "202": { + "headers": {}, + "body": { + "recordingsUrl": "https://contoso.com/", + "reportFileUrl": "https://contoso.com/", + "resultsUrls": { + "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", + "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" + }, + "models": [ + { + "modelKind": "Acoustic", + "datasets": [ + { + "dataImportKind": "Acoustic", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Acoustic model", + "description": "Example for an acoustic model" + }, + { + "modelKind": "Language", + "baseModel": { + "modelKind": "AcousticAndLanguage", + "datasets": [], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Base model", + "description": "Base model description" + }, + "datasets": [ + { + "dataImportKind": "Language", + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language dataset", + "properties": { + "AcceptedLines": "11", + "RejectedLines": "2", + "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" + } + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Running", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Language model", + "description": "This is a language model" + } + ], + "lastActionDateTime": "2019-01-07T12:36:07Z", + "status": "Succeeded", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "createdDateTime": "2019-01-07T12:34:12Z", + "locale": "en-US", + "name": "Transcription using locale en-US", + "properties": { + "ProfanityFilterMode": "Masked", + "PunctuationMode": "DictatedAndAutomatic", + "Duration": "00:00:42" + } + } + }, "400": { "headers": {}, "body": { From 26678492137cacf5ce05b3f52c569263707449c7 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Wed, 3 Mar 2021 19:50:36 +0100 Subject: [PATCH 29/34] moar fixes --- .../v2.0/examples/create_transcription.json | 86 +------------------ .../stable/v2.0/examples/delete_model.jsom | 40 --------- .../stable/v2.0/speechtotext.json | 7 +- 3 files changed, 2 insertions(+), 131 deletions(-) delete mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json index d396461de0d3..1cee7268bde9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json @@ -20,91 +20,7 @@ }, "responses": { "202": { - "headers": {}, - "body": { - "recordingsUrl": "https://contoso.com/", - "reportFileUrl": "https://contoso.com/", - "resultsUrls": { - "channel_0": "https://contoso.com/audiofile1.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=6c044930-3926-4be4-be76-f72832e6600c", - "channel_1": "https://contoso.com/audiofile2.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=3e0163f1-0029-4d4a-988d-3fba7d7c53b5" - }, - "models": [ - { - "modelKind": "Acoustic", - "datasets": [ - { - "dataImportKind": "Acoustic", - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", - "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "name": "Acoustic dataset", - "properties": { - "AcceptedLines": "11", - "RejectedLines": "2", - "ReportUri": "https://www.contoso.com/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e" - } - } - ], - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Running", - "id": "827712a5-f942-4997-91c3-7c6cde35600b", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "name": "Acoustic model", - "description": "Example for an acoustic model" - }, - { - "modelKind": "Language", - "baseModel": { - "modelKind": "AcousticAndLanguage", - "datasets": [], - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", - "id": "b28b9e52-395c-4d1b-b5a7-2c6fc4dd5715", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "name": "Base model", - "description": "Base model description" - }, - "datasets": [ - { - "dataImportKind": "Language", - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", - "id": "702d913a-8ba6-4f66-ad5c-897400b081fb", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "name": "Language dataset", - "properties": { - "AcceptedLines": "11", - "RejectedLines": "2", - "ReportUri": "https://www.contoso.com/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b" - } - } - ], - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Running", - "id": "827712a5-f942-4997-91c3-7c6cde35600b", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "name": "Language model", - "description": "This is a language model" - } - ], - "lastActionDateTime": "2019-01-07T12:36:07Z", - "status": "Succeeded", - "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", - "createdDateTime": "2019-01-07T12:34:12Z", - "locale": "en-US", - "name": "Transcription using locale en-US", - "properties": { - "ProfanityFilterMode": "Masked", - "PunctuationMode": "DictatedAndAutomatic", - "Duration": "00:00:42" - } - } + "headers": {} }, "400": { "headers": {}, diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom deleted file mode 100644 index 546850abab4d..000000000000 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.jsom +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}", - "id": "827712a5-f942-4997-91c3-7c6cde35600b" - }, - "responses": { - "204": { - "headers": {} - }, - "400": { - "headers": {}, - "body": { - "code": "BadRequest", - "message": "The request has been incorrect." - } - }, - "401": { - "headers": {}, - "body": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, - "403": { - "headers": {}, - "body": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, - "429": { - "headers": {}, - "body": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index ed81f21c1a9d..a9fadc6668f1 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -2699,9 +2699,7 @@ ], "responses": { "202": { - "description": "The response contains the id of the endpoint data export task.", - "schema": { - "$ref": "#/definitions/ErrorContent" + "description": "The response contains the id of the endpoint data export task in the header." }, "headers": { "Retry-After": { @@ -4750,9 +4748,6 @@ "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.", From d63f9ef3fcf716cf60d57b7657806789677538b8 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 4 Mar 2021 09:53:18 +0100 Subject: [PATCH 30/34] fix json issue --- .../Speech/SpeechToText/stable/v2.0/speechtotext.json | 3 +-- .../SpeechToText/stable/v3.0/examples/upload_dataset.json | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json index a9fadc6668f1..6598aaae85c9 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/speechtotext.json @@ -2699,8 +2699,7 @@ ], "responses": { "202": { - "description": "The response contains the id of the endpoint data export task in the header." - }, + "description": "The response contains the id of the endpoint data export task in the header.", "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json index 48f16eee06f3..adfd686eb0b2 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "project": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", "Content-Type": "multipart/form-data", + "project": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", "displayName": "My speech dataset name", "description": "My speech dataset description", "locale": "en-us", From 9687c9567a926bffd3a5a377a6c488bdc9199fa6 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 4 Mar 2021 11:05:36 +0100 Subject: [PATCH 31/34] remove secret --- .../SpeechToText/stable/v3.0/examples/create_web_hook.json | 2 +- .../SpeechToText/stable/v3.0/examples/update_web_hook.json | 2 +- .../SpeechToText/stable/v3.0/examples/upload_dataset.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json index d6daca7eedd2..be626d7c0e7a 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/create_web_hook.json @@ -5,7 +5,7 @@ "webHook": { "displayName": "TranscriptionCompletionWebHook", "properties": { - "secret": "SecretUsedToCreateHMACHexDigestThatYouWillFindIn\"X-MicrosoftSpeechServices-Signature\"HeaderWhenBeingCalledBack" + "secret": "$CREDENTIAL_PLACEHOLDER$" }, "webUrl": "https://contoso.com/call/me/back", "events": { diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json index e662a277d59c..0ffcbbf59ffb 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/update_web_hook.json @@ -5,7 +5,7 @@ "id": "2e856efe-ef53-465a-a632-6a084c1d349d", "webHookUpdate": { "properties": { - "secret": "SecretUsedToCreateHMACHexDigestThatYouWillFindIn\"X-MicrosoftSpeechServices-Signature\"HeaderWhenBeingCalledBack" + "secret": "$CREDENTIAL_PLACEHOLDER$" }, "events": { "evaluationCreation": true, diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json index adfd686eb0b2..48f16eee06f3 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}", - "Content-Type": "multipart/form-data", "project": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/projects/abc46f33-90b8-443d-adad-4870517356e0", + "Content-Type": "multipart/form-data", "displayName": "My speech dataset name", "description": "My speech dataset description", "locale": "en-us", From 8e358d462fbbb0d0d419c28220a1450ea6ab12c3 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 4 Mar 2021 11:57:22 +0100 Subject: [PATCH 32/34] add health status example --- .../v3.0/examples/get_healthstatus.json | 35 +++++++++++++++++++ .../stable/v3.0/speechtotext.json | 7 +++- 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json new file mode 100644 index 000000000000..af739019f6a5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "Healthy" + } + }, + "401": { + "headers": {}, + "body": { + "code": "Unauthorized", + "message": "Authentication is required to access the resource." + } + }, + "403": { + "headers": {}, + "body": { + "code": "Forbidden", + "message": "No permission to access this resource." + } + }, + "429": { + "headers": {}, + "body": { + "code": "TooManyRequests", + "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json index 53e8aa63bbee..f116ceaaa168 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/speechtotext.json @@ -6158,7 +6158,12 @@ "subscription_key": [], "token": [] } - ] + ], + "x-ms-examples": { + "Gets the health status": { + "$ref": "examples/get_healthstatus.json" + } + } } } }, From 35bdb349ad7e8897a82c2bde384dfa25fee17620 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Thu, 4 Mar 2021 12:20:32 +0100 Subject: [PATCH 33/34] fixed encoding --- .../stable/v3.0/examples/delete_model.jsom | 51 ------------------- .../v3.0/examples/get_healthstatus.json | 2 +- 2 files changed, 1 insertion(+), 52 deletions(-) delete mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom deleted file mode 100644 index 15b1775412a6..000000000000 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/delete_model.jsom +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "Endpoint": "https://westus.api.cognitive.microsoft.com/", - "Ocp-Apim-Subscription-Key": "{API Key}", - "id": "827712a5-f942-4997-91c3-7c6cde35600b" - }, - "responses": { - "204": { - "headers": {} - }, - "400": { - "headers": {}, - "body": { - "code": "InvalidRequest", - "message": "The base model isn't valid for this operation.", - "innerError": { - "code": "InvalidBaseModel", - "message": "The base model isn't valid for this operation." - } - } - }, - "401": { - "headers": {}, - "body": { - "code": "Unauthorized", - "message": "Authentication is required to access the resource." - } - }, - "403": { - "headers": {}, - "body": { - "code": "Forbidden", - "message": "No permission to access this resource." - } - }, - "404": { - "headers": {}, - "body": { - "code": "NotFound", - "message": "The specified entity cannot be found." - } - }, - "429": { - "headers": {}, - "body": { - "code": "TooManyRequests", - "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header." - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json index af739019f6a5..5d5ed377205d 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/get_healthstatus.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com/", "Ocp-Apim-Subscription-Key": "{API Key}" From dea9bc44e228be0c09995c1e580e64fa89f7d946 Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Fri, 5 Mar 2021 06:41:36 +0100 Subject: [PATCH 34/34] fix upload examples --- .../SpeechToText/stable/v2.0/examples/upload_dataset.json | 5 +---- .../SpeechToText/stable/v3.0/examples/upload_dataset.json | 1 - 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json index fec20f8de7cc..8a30c97431ae 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/upload_dataset.json @@ -7,10 +7,7 @@ "description": "My speech dataset description", "locale": "en-us", "dataImportKind": "Acoustic", - "properties": "{ \"property\": \"true\" }", - "audiodata": "multipart-form-data", - "transcriptions": "multipart-form-data", - "languagedata": "multipart-form-data" + "properties": "{ \"property\": \"true\" }" }, "responses": { "202": { diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json index 48f16eee06f3..75788623be27 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.0/examples/upload_dataset.json @@ -9,7 +9,6 @@ "locale": "en-us", "kind": "Acoustic", "customProperties": "{ \"property\": \"true\" }", - "data": "multipart-form-data", "email": "info@contoso.com" }, "responses": {