swagger: '2.0' info: title: Microsoft Azure Speech Services API v3.0 description: Speech Services API v3.0. contact: name: Cognitive Services - Speech Services url: https://docs.microsoft.com/azure/cognitive-services/speech-service/support version: v3.0 paths: /datasets/locales: get: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: 'Microsoft Azure Gets A List Of Supported Locales For Datasets' operationId: microsoftAzureGetsupportedlocalesfordatasets produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DatasetLocales' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get the supported locales: $ref: ./examples/get_supported_dataset_locales.json description: Needs a more full description created. /datasets: get: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: 'Microsoft Azure Gets A List Of Datasets For The Authenticated Subscription' operationId: microsoftAzureGetdatasets produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all datasets: $ref: ./examples/get_datasets.json description: Needs a more full description created. post: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: >- Microsoft Azure Uploads And Creates A New Dataset By Getting The Data From A Specified Url operationId: microsoftAzureCreatedataset consumes: - application/json produces: - application/json parameters: - in: body name: dataset description: Definition for the new dataset. required: true schema: $ref: '#/definitions/Dataset' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Dataset' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create a dataset: $ref: ./examples/create_dataset.json description: Needs a more full description created. /datasets/{id}: get: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: 'Microsoft Azure Gets The Dataset Identified By The Given Id' operationId: microsoftAzureGetdataset 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a dataset: $ref: ./examples/get_dataset.json description: Needs a more full description created. patch: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: 'Microsoft Azure Updates The Mutable Details Of The Dataset Identified By Its Id' operationId: microsoftAzureUpdatedataset 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update a dataset: $ref: ./examples/update_dataset.json description: Needs a more full description created. delete: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: 'Microsoft Azure Deletes The Specified Dataset' operationId: microsoftAzureDeletedataset produces: - application/json parameters: - in: path name: id description: The identifier of the dataset. required: true type: string format: uuid responses: '204': description: The dataset was successfully deleted or did not exist. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a dataset: $ref: ./examples/delete_dataset.json description: Needs a more full description created. /datasets/upload: post: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: 'Microsoft Azure Uploads Data And Creates A New Dataset' operationId: microsoftAzureUploaddatasetfromform consumes: - multipart/form-data produces: - application/json parameters: - in: formData name: project description: >- The optional string representation of the url of a project. If set, the dataset will be associated with that project. type: string - in: formData name: displayName description: The name of this dataset (required). required: true type: string - in: formData name: description description: Optional description of this dataset. type: string - in: formData name: locale description: The locale of this dataset (required). required: true type: string - in: formData name: kind description: >- The kind of the dataset (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 datasets, a zip file containing the audio data and a text file containing the transcriptions for the audio data. For language datasets, a text file containing the language or pronunciation data. Required in both cases. type: file - in: formData name: email description: >- An optional string containing the email address to send email notifications to in case the operation completes. The value will be removed after successfully sending the email. type: string responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Dataset' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' deprecated: true x-ms-examples: Upload a dataset: $ref: ./examples/upload_dataset.json description: Needs a more full description created. /datasets/{id}/files: get: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: 'Microsoft Azure Gets The Files Of The Dataset Identified By The Given Id' operationId: microsoftAzureGetdatasetfiles produces: - application/json parameters: - in: path name: id description: The identifier of the dataset. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all files: $ref: ./examples/get_dataset_files.json description: Needs a more full description created. /datasets/{id}/files/{fileId}: get: tags: - 'Custom Speech Datasets for Model Adaptation:' summary: >- Microsoft Azure Gets One Specific File Identified With Fileid From A Dataset Identified With Id operationId: microsoftAzureGetdatasetfile produces: - application/json parameters: - in: path name: id description: The identifier of the dataset. required: true type: string format: uuid - in: path name: fileId description: The identifier of the file. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/File' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a file: $ref: ./examples/get_dataset_file.json description: Needs a more full description created. /endpoints/locales: get: tags: - 'Custom Speech Endpoints:' summary: 'Microsoft Azure Gets A List Of Supported Locales For Endpoint Creations' operationId: microsoftAzureGetsupportedlocalesforendpoints produces: - application/json responses: '200': description: OK schema: type: array items: type: string default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get the supported locales: $ref: ./examples/get_supported_endpoint_locales.json description: Needs a more full description created. /endpoints: get: tags: - 'Custom Speech Endpoints:' summary: 'Microsoft Azure Gets The List Of Endpoints For The Authenticated Subscription' operationId: microsoftAzureGetendpoints produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all endpoints: $ref: ./examples/get_endpoints.json description: Needs a more full description created. post: tags: - 'Custom Speech Endpoints:' summary: 'Microsoft Azure Creates A New Endpoint' operationId: microsoftAzureCreateendpoint consumes: - application/json produces: - application/json parameters: - in: body name: endpoint description: The details of the endpoint. required: true schema: $ref: '#/definitions/Endpoint' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Endpoint' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create an endpoint: $ref: ./examples/create_endpoint.json description: Needs a more full description created. /endpoints/{id}: get: tags: - 'Custom Speech Endpoints:' summary: 'Microsoft Azure Gets The Endpoint Identified By The Given Id' operationId: microsoftAzureGetendpoint 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get an endpoint: $ref: ./examples/get_endpoint.json description: Needs a more full description created. delete: tags: - 'Custom Speech Endpoints:' summary: 'Microsoft Azure Deletes The Endpoint Identified By The Given Id' operationId: microsoftAzureDeleteendpoint produces: - application/json parameters: - in: path name: id description: The identifier of the endpoint. required: true type: string format: uuid responses: '204': description: The model endpoint was successfully deleted. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete an endpoint: $ref: ./examples/delete_endpoint.json description: Needs a more full description created. patch: tags: - 'Custom Speech Endpoints:' summary: 'Microsoft Azure Updates The Metadata Of The Endpoint Identified By The Given Id' operationId: microsoftAzureUpdateendpoint 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update an endpoint: $ref: ./examples/update_endpoint.json description: Needs a more full description created. /endpoints/{id}/files/logs: get: tags: - 'Custom Speech Endpoints:' summary: >- Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored For A Given Endpoint operationId: microsoftAzureGetendpointlogs produces: - application/json parameters: - in: path name: id description: The identifier of the endpoint. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' - in: query name: skipToken description: >- Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined. type: string - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedFiles' headers: Retry-After: description: >- The minimum number of seconds to wait for a non terminal operation to complete. type: integer default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all endpoint logs: $ref: ./examples/get_endpoint_logs.json description: Needs a more full description created. delete: tags: - 'Custom Speech Endpoints:' summary: >- Microsoft Azure 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: microsoftAzureDeleteendpointlogs 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. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete all endpoint logs: $ref: ./examples/delete_endpoint_logs.json /endpoints/{id}/files/logs/{logId}: get: tags: - 'Custom Speech Endpoints:' summary: 'Microsoft Azure Gets A Specific Audio Or Transcription Log For A Given Endpoint' operationId: microsoftAzureGetendpointlog produces: - application/json parameters: - in: path name: id description: The identifier of the endpoint. required: true type: string format: uuid - in: path name: logId description: The identifier of the log. required: true type: string - $ref: '#/parameters/sasValidityQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/File' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get an endpoint log: $ref: ./examples/get_endpoint_log.json description: Needs a more full description created. delete: tags: - 'Custom Speech Endpoints:' summary: >- Microsoft Azure Deletes One Audio Or Transcription Log That Have Been Stored For A Given Endpoint operationId: microsoftAzureDeleteendpointlog produces: - application/json parameters: - in: path name: id description: The identifier of the endpoint. required: true type: string format: uuid - in: path name: logId description: The identifier of the log. required: true type: string responses: '204': description: The log was successfully deleted. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete an endpoint log: $ref: ./examples/delete_endpoint_log.json description: Needs a more full description created. /endpoints/base/{locale}/files/logs: get: tags: - 'Custom Speech Endpoints:' summary: >- Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored When Using The Default Base Model Of A Given Language operationId: microsoftAzureGetbasemodellogs produces: - application/json parameters: - in: path name: locale description: The language used to select the default base model. required: true type: string - $ref: '#/parameters/sasValidityQueryParameter' - in: query name: skipToken description: >- Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined. type: string - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedFiles' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all base model logs: $ref: ./examples/get_base_model_logs.json description: Needs a more full description created. delete: tags: - 'Custom Speech Endpoints:' summary: >- Microsoft Azure 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: microsoftAzureDeletebasemodellogs 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. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete all base model logs: $ref: ./examples/delete_base_model_logs.json /endpoints/base/{locale}/files/logs/{logId}: get: tags: - 'Custom Speech Endpoints:' summary: >- Microsoft Azure Gets A Specific Audio Or Transcription Log For The Default Base Model In A Given Language operationId: microsoftAzureGetbasemodellog produces: - application/json parameters: - in: path name: locale description: The language used to select the default base model. required: true type: string - in: path name: logId description: The identifier of the log. required: true type: string - $ref: '#/parameters/sasValidityQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/File' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a base model log: $ref: ./examples/get_base_model_log.json description: Needs a more full description created. delete: tags: - 'Custom Speech Endpoints:' summary: >- Microsoft Azure Deletes One Audio Or Transcription Log That Have Been Stored When Using The Default Base Model Of A Given Language operationId: microsoftAzureDeletebasemodellog produces: - application/json parameters: - in: path name: locale description: The language used to select the default base model. required: true type: string - in: path name: logId description: The identifier of the log. required: true type: string responses: '204': description: The log was successfully deleted. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a base model log: $ref: ./examples/delete_base_model_log.json description: Needs a more full description created. /evaluations/locales: get: tags: - 'Custom Speech Model Evaluations:' summary: 'Microsoft Azure Gets A List Of Supported Locales For Evaluations' operationId: microsoftAzureGetsupportedlocalesforevaluations produces: - application/json responses: '200': description: OK schema: type: array items: type: string default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get the supported locales: $ref: ./examples/get_supported_evaluations_locales.json description: Needs a more full description created. /evaluations: get: tags: - 'Custom Speech Model Evaluations:' summary: 'Microsoft Azure Gets The List Of Evaluations For The Authenticated Subscription' operationId: microsoftAzureGetevaluations produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all evaluations: $ref: ./examples/get_evaluations.json description: Needs a more full description created. post: tags: - 'Custom Speech Model Evaluations:' summary: 'Microsoft Azure Creates A New Evaluation' operationId: microsoftAzureCreateevaluation consumes: - application/json produces: - application/json parameters: - in: body name: evaluation description: The details of the new evaluation. required: true schema: $ref: '#/definitions/Evaluation' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Evaluation' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create a evaluation: $ref: ./examples/create_evaluation.json description: Needs a more full description created. /evaluations/{id}/files: get: tags: - 'Custom Speech Model Evaluations:' summary: 'Microsoft Azure Gets The Files Of The Evaluation Identified By The Given Id' operationId: microsoftAzureGetevaluationfiles produces: - application/json parameters: - in: path name: id description: The identifier of the evaluation. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all files: $ref: ./examples/get_evaluation_files.json description: Needs a more full description created. /evaluations/{id}/files/{fileId}: get: tags: - 'Custom Speech Model Evaluations:' summary: >- Microsoft Azure Gets One Specific File Identified With Fileid From An Evaluation Identified With Id operationId: microsoftAzureGetevaluationfile produces: - application/json parameters: - in: path name: id description: The identifier of the evaluation. required: true type: string format: uuid - in: path name: fileId description: The identifier of the file. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/File' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a file: $ref: ./examples/get_evaluation_file.json description: Needs a more full description created. /evaluations/{id}: get: tags: - 'Custom Speech Model Evaluations:' summary: 'Microsoft Azure Gets The Evaluation Identified By The Given Id' operationId: microsoftAzureGetevaluation 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a evaluation: $ref: ./examples/get_evaluation.json description: Needs a more full description created. patch: tags: - 'Custom Speech Model Evaluations:' summary: 'Microsoft Azure Updates The Mutable Details Of The Evaluation Identified By Its Id' operationId: microsoftAzureUpdateevaluation 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update a evaluation: $ref: ./examples/update_evaluation.json description: Needs a more full description created. delete: tags: - 'Custom Speech Model Evaluations:' summary: 'Microsoft Azure Deletes The Evaluation Identified By The Given Id' operationId: microsoftAzureDeleteevaluation produces: - application/json parameters: - in: path name: id description: The identifier of the evaluation. required: true type: string format: uuid responses: '204': description: The evaluation was successfully deleted or did not exist. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a evaluation: $ref: ./examples/delete_evaluation.json description: Needs a more full description created. /models/locales: get: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Gets A List Of Supported Locales For Model Adaptation' operationId: microsoftAzureGetsupportedlocalesformodels produces: - application/json responses: '200': description: OK schema: type: array items: type: string default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get the supported locales: $ref: ./examples/get_supported_model_locales.json description: Needs a more full description created. /models: get: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Gets The List Of Custom Models For The Authenticated Subscription' operationId: microsoftAzureGetmodels produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all models: $ref: ./examples/get_models.json description: Needs a more full description created. post: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Creates A New Model' operationId: microsoftAzureCreatemodel consumes: - application/json produces: - application/json parameters: - in: body name: model description: The details of the new model. required: true schema: $ref: '#/definitions/Model' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Model' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create a model: $ref: ./examples/create_model.json description: Needs a more full description created. /models/base: get: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Gets The List Of Base Models For The Authenticated Subscription' operationId: microsoftAzureGetbasemodels produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedModels' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all base models: $ref: ./examples/get_base_models.json description: Needs a more full description created. /models/{id}: get: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Gets The Model Identified By The Given Id' operationId: microsoftAzureGetmodel 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a model: $ref: ./examples/get_model.json description: Needs a more full description created. patch: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Updates The Metadata Of The Model Identified By The Given Id' operationId: microsoftAzureUpdatemodel 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update a model: $ref: ./examples/update_model.json description: Needs a more full description created. delete: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Deletes The Model Identified By The Given Id' operationId: microsoftAzureDeletemodel produces: - application/json parameters: - in: path name: id description: The identifier of the model. required: true type: string format: uuid responses: '204': description: The model was successfully deleted or did not exist. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a model: $ref: ./examples/delete_model.json description: Needs a more full description created. /models/base/{id}: get: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure Gets The Base Model Identified By The Given Id' operationId: microsoftAzureGetbasemodel 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' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a base model: $ref: ./examples/get_base_model.json description: Needs a more full description created. /models/{id}/copyto: post: tags: - 'Custom Speech Models:' summary: 'Microsoft Azure 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
key belongs to a subscription created for another location, the model will be copied to that location.
Only adapted models are allowed to copy to another subscription. operationId: microsoftAzureCopymodeltosubscription consumes: - application/json produces: - application/json parameters: - in: path name: id description: The identifier of the model that will be copied. required: true type: string format: uuid - in: body name: modelCopy description: The body contains the subscription key of the target subscription. required: true schema: $ref: '#/definitions/ModelCopy' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Model' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Copy a model: $ref: ./examples/copy_model.json /models/{id}/manifest: get: tags: - 'Custom Speech Models:' summary: >- Microsoft Azure Returns An Manifest For This Model Which Can Be Used In An On Premise Container operationId: microsoftAzureGetmodelmanifest produces: - application/json parameters: - in: path name: id description: The ID of the model to generate a manifest for. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' responses: '200': description: Successfully generated a model manifest. schema: $ref: '#/definitions/ModelManifest' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a model manifest: $ref: ./examples/get_model_manifest.json description: Needs a more full description created. /models/base/{id}/manifest: get: tags: - 'Custom Speech Models:' summary: >- Microsoft Azure Returns An Manifest For This Base Model Which Can Be Used In An On Premise Container operationId: microsoftAzureGetbasemodelmanifest produces: - application/json parameters: - in: path name: id description: The ID of the model to generate a manifest for. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' responses: '200': description: Successfully generated a model manifest. schema: $ref: '#/definitions/ModelManifest' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a base model manifest: $ref: ./examples/get_base_model_manifest.json description: Needs a more full description created. /projects/locales: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The List Of Supported Locales' operationId: microsoftAzureGetsupportedprojectlocales produces: - application/json responses: '200': description: OK schema: type: array items: type: string default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get the supported locales: $ref: ./examples/get_supported_project_locales.json description: Needs a more full description created. /projects: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The List Of Projects For The Authenticated Subscription' operationId: microsoftAzureGetprojects produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedProjects' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all projects: $ref: ./examples/get_projects.json description: Needs a more full description created. post: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Creates A New Project' operationId: microsoftAzureCreateproject consumes: - application/json produces: - application/json parameters: - in: body name: project description: The details of the project. required: true schema: $ref: '#/definitions/Project' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Project' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create a project: $ref: ./examples/create_project.json description: Needs a more full description created. /projects/{id}: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The Project Identified By The Given Id' operationId: microsoftAzureGetproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid responses: '200': description: OK schema: $ref: '#/definitions/Project' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a project: $ref: ./examples/get_project.json description: Needs a more full description created. patch: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Updates The Project Identified By The Given Id' operationId: microsoftAzureUpdateproject consumes: - application/json - application/merge-patch+json produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - in: body name: projectUpdate description: The updated values for the project. required: true schema: $ref: '#/definitions/ProjectUpdate' responses: '200': description: OK schema: $ref: '#/definitions/Project' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update a project: $ref: ./examples/update_project.json description: Needs a more full description created. delete: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Deletes The Project Identified By The Given Id' operationId: microsoftAzureDeleteproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid responses: '204': description: The project was successfully deleted or did not exist. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a project: $ref: ./examples/delete_project.json description: Needs a more full description created. /projects/{id}/evaluations: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The List Of Evaluations For Specified Project' operationId: microsoftAzureGetevaluationsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all evaluations: $ref: ./examples/get_project_evaluations.json description: Needs a more full description created. /projects/{id}/datasets: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The List Of Datasets For Specified Project' operationId: microsoftAzureGetdatasetsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all datasets: $ref: ./examples/get_project_datasets.json description: Needs a more full description created. /projects/{id}/endpoints: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The List Of Endpoints For Specified Project' operationId: microsoftAzureGetendpointsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all endpoints: $ref: ./examples/get_project_endpoints.json description: Needs a more full description created. /projects/{id}/models: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The List Of Models For Specified Project' operationId: microsoftAzureGetmodelsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all models: $ref: ./examples/get_project_models.json description: Needs a more full description created. /projects/{id}/transcriptions: get: tags: - 'Custom Speech Projects:' summary: 'Microsoft Azure Gets The List Of Transcriptions For Specified Project' operationId: microsoftAzureGettranscriptionsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all transcriptions: $ref: ./examples/get_project_transcriptions.json description: Needs a more full description created. /transcriptions/locales: get: tags: - 'Custom Speech Transcriptions:' summary: 'Microsoft Azure Gets A List Of Supported Locales For Offline Transcriptions' operationId: microsoftAzureGetsupportedlocalesfortranscriptions produces: - application/json responses: '200': description: OK schema: type: array items: type: string default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get the supported locales: $ref: ./examples/get_supported_transcription_locales.json description: Needs a more full description created. /transcriptions: get: tags: - 'Custom Speech Transcriptions:' summary: 'Microsoft Azure Gets A List Of Transcriptions For The Authenticated Subscription' operationId: microsoftAzureGettranscriptions produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all transcriptions: $ref: ./examples/get_transcriptions.json description: Needs a more full description created. post: tags: - 'Custom Speech Transcriptions:' summary: 'Microsoft Azure Creates A New Transcription' operationId: microsoftAzureCreatetranscription consumes: - application/json produces: - application/json parameters: - in: body name: transcription description: The details of the new transcription. required: true schema: $ref: '#/definitions/Transcription' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Transcription' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create a transcription for URIs: $ref: ./examples/create_uri_transcription.json Create a transcription from blob container: $ref: ./examples/create_container_transcription.json description: Needs a more full description created. /transcriptions/{id}: get: tags: - 'Custom Speech Transcriptions:' summary: 'Microsoft Azure Gets The Transcription Identified By The Given Id' operationId: microsoftAzureGettranscription 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a transcription: $ref: ./examples/get_transcription.json description: Needs a more full description created. patch: tags: - 'Custom Speech Transcriptions:' summary: 'Microsoft Azure Updates The Mutable Details Of The Transcription Identified By Its Id' operationId: microsoftAzureUpdatetranscription 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update a transcription: $ref: ./examples/update_transcription.json description: Needs a more full description created. delete: tags: - 'Custom Speech Transcriptions:' summary: 'Microsoft Azure Deletes The Specified Transcription Task' operationId: microsoftAzureDeletetranscription produces: - application/json parameters: - in: path name: id description: The identifier of the transcription. required: true type: string format: uuid responses: '204': description: The transcription was successfully deleted or did not exist. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a transcription: $ref: ./examples/delete_transcription.json description: Needs a more full description created. /transcriptions/{id}/files: get: tags: - 'Custom Speech Transcriptions:' summary: 'Microsoft Azure Gets The Files Of The Transcription Identified By The Given Id' operationId: microsoftAzureGettranscriptionfiles produces: - application/json parameters: - in: path name: id description: The identifier of the transcription. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all files: $ref: ./examples/get_transcription_files.json description: Needs a more full description created. /transcriptions/{id}/files/{fileId}: get: tags: - 'Custom Speech Transcriptions:' summary: >- Microsoft Azure Gets One Specific File Identified With Fileid From A Transcription Identified With Id operationId: microsoftAzureGettranscriptionfile produces: - application/json parameters: - in: path name: id description: The identifier of the transcription. required: true type: string format: uuid - in: path name: fileId description: The identifier of the file. required: true type: string format: uuid - $ref: '#/parameters/sasValidityQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/File' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a file: $ref: ./examples/get_transcription_file.json description: Needs a more full description created. /webhooks: get: tags: - 'Custom Speech Web Hooks:' summary: 'Microsoft Azure Gets The List Of Web Hooks For The Authenticated Subscription' operationId: microsoftAzureGethooks produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all web hooks: $ref: ./examples/get_web_hooks.json description: Needs a more full description created. post: tags: - 'Custom Speech Web Hooks:' summary: 'Microsoft Azure 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
the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.

When calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event
types. There will be one request per registered event type.

After 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
challenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken
query parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events. operationId: microsoftAzureCreatehook consumes: - application/json produces: - application/json parameters: - in: body name: webHook description: The details of the new web hook. required: true schema: $ref: '#/definitions/WebHook' responses: '201': description: >- The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/WebHook' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create a web hook: $ref: ./examples/create_web_hook.json /webhooks/{id}: get: tags: - 'Custom Speech Web Hooks:' summary: 'Microsoft Azure Gets The Web Hook Identified By The Given Id' operationId: microsoftAzureGethook 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a web hook: $ref: ./examples/get_web_hook.json description: Needs a more full description created. patch: tags: - 'Custom Speech Web Hooks:' summary: 'Microsoft Azure 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
headers. 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
will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.

If the URL changes, the web hook will stop receiving events until a
challenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken.
Respond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response
is successfully completed, the web hook will begin receiving events. operationId: microsoftAzureUpdatehook 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update a web hook: $ref: ./examples/update_web_hook.json delete: tags: - 'Custom Speech Web Hooks:' summary: 'Microsoft Azure Deletes The Web Hook Identified By The Given Id' operationId: microsoftAzureDeletehook produces: - application/json parameters: - in: path name: id description: The identifier of the web hook. required: true type: string format: uuid responses: '204': description: The web hook was successfully deleted. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a web hook: $ref: ./examples/delete_web_hook.json description: Needs a more full description created. /webhooks/{id}/ping: post: tags: - 'Custom Speech Web Hooks:' summary: 'Microsoft Azure 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.
The Swagger Schema ID of the model is WebHookV3.

The request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with
a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with
the secret as HMAC key. The hash is base64 encoded. operationId: microsoftAzurePinghook 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 default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Ping a web hook: $ref: ./examples/ping_web_hook.json /webhooks/{id}/test: post: tags: - 'Custom Speech Web Hooks:' summary: 'Microsoft Azure 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,
the POST will respond with 204. If a test request can be made, it will respond with 200.
The request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.
If the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with
the secret as HMAC key. The hash is base64 encoded. operationId: microsoftAzureTesthook 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 '204': description: >- No entity could be found for any event type, so no test request is sent to the registered web hook. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Test a web hook: $ref: ./examples/test_web_hook.json /healthstatus: get: tags: - 'Service Health:' summary: >- Microsoft Azure Returns The Overall Health Of The Service And Optionally Of The Different Subcomponents operationId: microsoftAzureGethealthstatus produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceHealth' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Gets the health status: $ref: examples/get_healthstatus.json description: Needs a more full description created. 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: $ref: '#/definitions/HealthStatus' type: description: The type of this component. type: string readOnly: true Dataset: title: Dataset required: - displayName - kind - locale type: object properties: links: $ref: '#/definitions/Links' properties: $ref: '#/definitions/DatasetProperties' kind: $ref: '#/definitions/DatasetKind' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string project: $ref: '#/definitions/EntityReference' contentUrl: format: uri description: The URL of the data for the dataset. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string locale: description: The locale of the contained data. type: string lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true DatasetKind: title: DatasetKind description: Type of data import. enum: - Language - Acoustic - Pronunciation - AudioFiles type: string x-ms-enum: name: DatasetKind modelAsString: false values: - value: Language description: A language data import. - value: Acoustic description: An acoustic data import. - value: Pronunciation description: A pronunciation data import. - value: AudioFiles description: An audio files data import. DatasetLocales: title: DatasetLocales type: object additionalProperties: type: array items: $ref: '#/definitions/DatasetKind' DatasetProperties: title: DatasetProperties type: object properties: acceptedLineCount: format: int32 description: The number of lines accepted for this data set. type: integer readOnly: true rejectedLineCount: format: int32 description: The number of lines rejected for this data set. type: integer readOnly: true duration: description: "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string readOnly: true email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' DatasetUpdate: title: DatasetUpdate type: object properties: project: $ref: '#/definitions/EntityReference' displayName: description: The name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string DetailedErrorCode: title: DetailedErrorCode description: Detailed error code enum. enum: - InvalidParameterValue - InvalidRequestBodyFormat - EmptyRequest - MissingInputRecords - InvalidDocument - ModelVersionIncorrect - InvalidDocumentBatch - UnsupportedLanguageCode - DataImportFailed - InUseViolation - InvalidLocale - InvalidBaseModel - InvalidAdaptationMapping - InvalidDataset - InvalidTest - FailedDataset - InvalidModel - InvalidTranscription - InvalidPayload - InvalidParameter - EndpointWithoutLogging - InvalidPermissions - InvalidPrerequisite - InvalidProductId - InvalidSubscription - InvalidProject - InvalidProjectKind - InvalidRecordingsUri - OnlyOneOfUrlsOrContainerOrDataset - ExceededNumberOfRecordingsUris - ModelMismatch - ProjectGenderMismatch - ModelDeprecated - ModelExists - ModelNotDeployable - EndpointNotUpdatable - SingleDefaultEndpoint - EndpointCannotBeDefault - InvalidModelUri - SubscriptionNotFound - QuotaViolation - UnsupportedDelta - UnsupportedFilter - UnsupportedPagination - UnsupportedDynamicConfiguration - UnsupportedOrderBy - NoUtf8WithBom - ModelDeploymentNotCompleteState - SkuLimitsExist - DeployingFailedModel - UnsupportedTimeRange - InvalidLogDate - InvalidLogId - InvalidLogStartTime - InvalidLogEndTime - InvalidTopForLogs - InvalidSkipTokenForLogs - DeleteNotAllowed - Forbidden - DeployNotAllowed - UnexpectedError - InvalidCollection - InvalidCallbackUri - InvalidSasValidityDuration - InaccessibleCustomerStorage - UnsupportedClassBasedAdaptation - InvalidWebHookEventKind - InvalidTimeToLive type: string x-ms-enum: name: DetailedErrorCode modelAsString: true values: - value: InvalidParameterValue description: Invalid parameter value. - value: InvalidRequestBodyFormat description: Invalid request body format. - value: EmptyRequest description: Empty Request. - value: MissingInputRecords description: Missing Input Records. - value: InvalidDocument description: Invalid Document. - value: ModelVersionIncorrect description: Model Version Incorrect. - value: InvalidDocumentBatch description: Invalid Document Batch. - value: UnsupportedLanguageCode description: Unsupported language code. - value: DataImportFailed description: Data import failed. - value: InUseViolation description: In use violation. - value: InvalidLocale description: Invalid locale. - value: InvalidBaseModel description: Invalid base model. - value: InvalidAdaptationMapping description: Invalid adaptation mapping. - value: InvalidDataset description: Invalid dataset. - value: InvalidTest description: Invalid test. - value: FailedDataset description: Failed dataset. - value: InvalidModel description: Invalid model. - value: InvalidTranscription description: Invalid transcription. - value: InvalidPayload description: Invalid payload. - value: InvalidParameter description: Invalid parameter. - value: EndpointWithoutLogging description: Endpoint without logging. - value: InvalidPermissions description: Invalid permissions. - value: InvalidPrerequisite description: Invalid prerequisite. - value: InvalidProductId description: Invalid product id. - value: InvalidSubscription description: Invalid subscription. - value: InvalidProject description: Invalid project. - value: InvalidProjectKind description: Invalid project kind. - value: InvalidRecordingsUri description: Invalid recordings uri. - value: OnlyOneOfUrlsOrContainerOrDataset description: Only one of urls or container or dataset. - value: ExceededNumberOfRecordingsUris description: Exceeded number of recordings uris. - value: ModelMismatch description: Model mismatch. - value: ProjectGenderMismatch description: Project gender mismatch. - value: ModelDeprecated description: Model deprecated. - value: ModelExists description: Model exists. - value: ModelNotDeployable description: Model not deployable. - value: EndpointNotUpdatable description: Endpoint not updatable. - value: SingleDefaultEndpoint description: Single default endpoint. - value: EndpointCannotBeDefault description: Endpoint cannot be default. - value: InvalidModelUri description: Invalid model uri. - value: SubscriptionNotFound description: Subscription not found. - value: QuotaViolation description: Quota violation. - value: UnsupportedDelta description: Unsupported delta. - value: UnsupportedFilter description: Unsupported filter. - value: UnsupportedPagination description: Unsupported pagination. - value: UnsupportedDynamicConfiguration description: Unsupported dynamic configuration. - value: UnsupportedOrderBy description: Unsupported order by. - value: NoUtf8WithBom description: No utf8 with bom. - value: ModelDeploymentNotCompleteState description: Model deployment not complete state. - value: SkuLimitsExist description: Sku limits exist. - value: DeployingFailedModel description: Deploying failed model. - value: UnsupportedTimeRange description: Unsupported time range. - value: InvalidLogDate description: Invalid log date. - value: InvalidLogId description: Invalid log id. - value: InvalidLogStartTime description: Invalid log start time. - value: InvalidLogEndTime description: Invalid log end time. - value: InvalidTopForLogs description: Invalid top for logs. - value: InvalidSkipTokenForLogs description: Invalid skip token for logs. - value: DeleteNotAllowed description: Delete not allowed. - value: Forbidden description: Forbidden. - value: DeployNotAllowed description: Deploy not allowed. - value: UnexpectedError description: Unexpected error. - value: InvalidCollection description: Invalid collection. - value: InvalidCallbackUri description: Invalid callback uri. - value: InvalidSasValidityDuration description: Invalid sas validity duration. - value: InaccessibleCustomerStorage description: Inaccessible customer storage. - value: UnsupportedClassBasedAdaptation description: Unsupported class based adaptation. - value: InvalidWebHookEventKind description: Invalid web hook event kind. - value: InvalidTimeToLive description: Invalid time to live. Endpoint: title: Endpoint required: - displayName - locale type: object properties: project: $ref: '#/definitions/EntityReference' links: $ref: '#/definitions/EndpointLinks' properties: $ref: '#/definitions/EndpointProperties' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string text: description: The text used to adapt a language model for this endpoint. type: string model: $ref: '#/definitions/EntityReference' locale: description: The locale of the contained data. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true EndpointLinks: title: EndpointLinks type: object properties: restInteractive: format: uri description: The REST endpoint for short requests up to 15 seconds. type: string readOnly: true restConversation: format: uri description: The REST endpoint for requests up to 60 seconds. type: string readOnly: true restDictation: format: uri description: >- The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks. type: string readOnly: true webSocketInteractive: format: uri description: >- The Speech SDK endpoint for short requests up to 15 seconds with a single final result. type: string readOnly: true webSocketConversation: format: uri description: The Speech SDK endpoint for long requests with multiple final results. type: string readOnly: true webSocketDictation: format: uri description: "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks." type: string readOnly: true logs: format: uri description: The audio and transcription logs for this endpoint. 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. The longest supported duration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' EndpointPropertiesUpdate: title: EndpointPropertiesUpdate type: object properties: contentLoggingEnabled: description: "A value indicating whether content logging (audio & transcriptions)\r\nis being used for a deployment." type: boolean EndpointUpdate: title: EndpointUpdate type: object properties: model: $ref: '#/definitions/EntityReference' properties: $ref: '#/definitions/EndpointPropertiesUpdate' project: $ref: '#/definitions/EntityReference' displayName: description: The name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string EntityError: title: EntityError type: object properties: code: description: The code of this error. type: string readOnly: true message: description: The message for this error. type: string readOnly: true EntityReference: title: EntityReference required: - self type: object properties: self: format: uri description: The location of the referenced entity. type: string Error: title: Error description: "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details." type: object properties: code: $ref: '#/definitions/ErrorCode' details: description: >- Additional supportive details regarding the error and/or expected policies. type: array items: $ref: '#/definitions/Error' message: description: High level error message. type: string target: description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document." type: string innerError: $ref: '#/definitions/InnerError' ErrorCode: title: ErrorCode description: High level error codes. enum: - InvalidRequest - InvalidArgument - InternalServerError - ServiceUnavailable - NotFound - PipelineError - Conflict - InternalCommunicationFailed - Forbidden - NotAllowed - Unauthorized - UnsupportedMediaType - TooManyRequests - UnprocessableEntity type: string x-ms-enum: name: ErrorCode modelAsString: true values: - value: InvalidRequest description: Representing the invalid request error code. - value: InvalidArgument description: Representing the invalid argument error code. - value: InternalServerError description: Representing the internal server error error code. - value: ServiceUnavailable description: Representing the service unavailable error code. - value: NotFound description: Representing the not found error code. - value: PipelineError description: Representing the pipeline error error code. - value: Conflict description: Representing the conflict error code. - value: InternalCommunicationFailed description: Representing the internal communication failed error code. - value: Forbidden description: Representing the forbidden error code. - value: NotAllowed description: Representing the not allowed error code. - value: Unauthorized description: Representing the unauthorized error code. - value: UnsupportedMediaType description: Representing the unsupported media type error code. - value: TooManyRequests description: Representing the too many requests error code. - value: UnprocessableEntity description: Representing the unprocessable entity error code. Evaluation: title: Evaluation required: - dataset - displayName - locale - model1 - model2 type: object properties: model1: $ref: '#/definitions/EntityReference' model2: $ref: '#/definitions/EntityReference' transcription1: $ref: '#/definitions/EntityReference' transcription2: $ref: '#/definitions/EntityReference' dataset: $ref: '#/definitions/EntityReference' links: $ref: '#/definitions/Links' properties: $ref: '#/definitions/EvaluationProperties' project: $ref: '#/definitions/EntityReference' self: format: uri description: The location of this entity. type: string readOnly: true lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string locale: description: The locale of the contained data. type: string EvaluationProperties: title: EvaluationProperties type: object properties: wordErrorRate2: format: double description: The word error rate of recognition with model2. type: number readOnly: true wordErrorRate1: format: double description: The word error rate of recognition with model1. type: number readOnly: true sentenceErrorRate2: format: double description: The sentence error rate of recognition with model2. type: number readOnly: true sentenceCount2: format: int32 description: The number of processed sentences by model2. type: integer readOnly: true wordCount2: format: int32 description: The number of processed words by model2. type: integer readOnly: true correctWordCount2: format: int32 description: The number of correctly recognized words by model2. type: integer readOnly: true wordSubstitutionCount2: format: int32 description: The number of recognized words by model2, that are substitutions. type: integer readOnly: true wordDeletionCount2: format: int32 description: The number of recognized words by model2, that are deletions. type: integer readOnly: true wordInsertionCount2: format: int32 description: The number of recognized words by model2, that are insertions. type: integer readOnly: true sentenceErrorRate1: format: double description: The sentence error rate of recognition with model1. type: number readOnly: true sentenceCount1: format: int32 description: The number of processed sentences by model1. type: integer readOnly: true wordCount1: format: int32 description: The number of processed words by model1. type: integer readOnly: true correctWordCount1: format: int32 description: The number of correctly recognized words by model1. type: integer readOnly: true wordSubstitutionCount1: format: int32 description: The number of recognized words by model1, that are substitutions. type: integer readOnly: true wordDeletionCount1: format: int32 description: The number of recognized words by model1, that are deletions. type: integer readOnly: true wordInsertionCount1: format: int32 description: The number of recognized words by model1, that are insertions. type: integer readOnly: true email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' EvaluationUpdate: title: EvaluationUpdate type: object properties: project: $ref: '#/definitions/EntityReference' displayName: description: The name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string File: title: File type: object properties: kind: $ref: '#/definitions/FileKind' links: $ref: '#/definitions/FileLinks' createdDateTime: format: date-time description: "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true properties: $ref: '#/definitions/FileProperties' name: description: The name of this file. type: string readOnly: true self: format: uri description: The location of this entity. type: string readOnly: true FileKind: title: FileKind description: Type of data. enum: - DatasetReport - Audio - LanguageData - PronunciationData - AcousticDataArchive - AcousticDataTranscriptionV2 - Transcription - TranscriptionReport - EvaluationDetails type: string readOnly: true x-ms-enum: name: FileKind modelAsString: true values: - value: DatasetReport description: Type of data is dataset report. - value: Audio description: Type of data is audio. - value: LanguageData description: Type of data is language data. - value: PronunciationData description: Type of data is pronunciation data. - value: AcousticDataArchive description: Type of data is acoustic data archive. - value: AcousticDataTranscriptionV2 description: Type of data is acoustic data transcription v2. - value: Transcription description: Type of data is transcription. - value: TranscriptionReport description: Type of data is transcription report. - value: EvaluationDetails description: Type of data is evaluation details. FileLinks: title: FileLinks type: object properties: contentUrl: format: uri description: The url to retrieve the content of this file. type: string readOnly: true FileProperties: title: FileProperties type: object properties: size: format: int64 description: The size of the data in bytes. type: integer readOnly: true duration: description: "The duration in case this file is an audio file. The duration is encoded as ISO 8601\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string readOnly: true HealthStatus: title: HealthStatus description: Health status of the service. enum: - Unhealthy - Degraded - Healthy type: string readOnly: true x-ms-enum: name: HealthStatus modelAsString: false values: - value: Unhealthy description: Unhealthy. - value: Degraded description: Degraded. - value: Healthy description: Healthy. InnerError: title: InnerError description: "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested)." type: object properties: code: $ref: '#/definitions/DetailedErrorCode' details: description: >- Additional supportive details regarding the error and/or expected policies. type: object additionalProperties: type: string message: description: High level error message. type: string target: description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document." type: string innerError: $ref: '#/definitions/InnerError' Links: title: Links type: object properties: files: format: uri description: The location to get all files of this entity. type: string readOnly: true Model: title: Model required: - displayName - locale type: object properties: project: $ref: '#/definitions/EntityReference' links: $ref: '#/definitions/ModelLinks' properties: $ref: '#/definitions/ModelProperties' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string text: description: The text used to adapt this language model. type: string baseModel: $ref: '#/definitions/EntityReference' datasets: description: Datasets used for adaptation. type: array items: $ref: '#/definitions/EntityReference' locale: description: The locale of the contained data. type: string lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true 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: format: uri description: The url to retrieve the content of this file. type: string readOnly: true ModelLinks: title: ModelLinks type: object properties: manifest: format: uri description: >- The location to get a manifest for this model to be used in the on-prem container. type: string readOnly: true copyTo: format: uri description: The location to the model copy action. type: string readOnly: true ModelManifest: title: ModelManifest required: - model - modelFiles - properties type: object properties: model: $ref: '#/definitions/EntityReference' modelFiles: description: The model files of this model. type: array items: $ref: '#/definitions/ModelFile' properties: description: The configuration for running this model in a container. type: object additionalProperties: type: object ModelProperties: title: ModelProperties type: object properties: deprecationDates: $ref: '#/definitions/ModelDeprecationDates' email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' ModelUpdate: title: ModelUpdate type: object properties: project: $ref: '#/definitions/EntityReference' displayName: description: The name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string PaginatedDatasets: title: PaginatedDatasets type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Dataset' readOnly: true '@nextLink': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedEndpoints: title: PaginatedEndpoints type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Endpoint' readOnly: true '@nextLink': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedEvaluations: title: PaginatedEvaluations type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Evaluation' readOnly: true '@nextLink': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedFiles: title: PaginatedFiles type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/File' readOnly: true '@nextLink': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true 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': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedProjects: title: PaginatedProjects type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Project' readOnly: true '@nextLink': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedTranscriptions: title: PaginatedTranscriptions type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Transcription' readOnly: true '@nextLink': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedWebHooks: title: PaginatedWebHooks type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/WebHook' readOnly: true '@nextLink': format: uri description: >- A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true ProfanityFilterMode: title: ProfanityFilterMode description: Mode of profanity filtering. enum: - None - Removed - Tags - Masked type: string x-ms-enum: name: ProfanityFilterMode modelAsString: false values: - value: None description: Disable profanity filtering. - value: Removed description: Remove profanity. - value: Tags description: Add "profanity" XML tags</Profanity> - value: Masked description: Mask the profanity with * except of the first letter, e.g., f*** Project: title: Project required: - displayName - locale type: object properties: links: $ref: '#/definitions/ProjectLinks' properties: $ref: '#/definitions/ProjectProperties' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. 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: format: uri description: The location to get a list of all evaluations of this project. type: string readOnly: true datasets: format: uri description: The location to get a list of all datasets of this project. type: string readOnly: true models: format: uri description: The location to get a list of all models of this project. type: string readOnly: true endpoints: format: uri description: The location to get a list of all endpoints of this project. type: string readOnly: true transcriptions: format: uri 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 PunctuationMode: title: PunctuationMode description: The mode used for punctuation. enum: - None - Dictated - Automatic - DictatedAndAutomatic type: string x-ms-enum: name: PunctuationMode modelAsString: false values: - value: None description: No punctuation. - value: Dictated description: Dictated punctuation marks only, i.e., explicit punctuation. - value: Automatic description: Automatic punctuation. - value: DictatedAndAutomatic description: Dictated punctuation marks or automatic punctuation. ServiceHealth: title: ServiceHealth type: object properties: status: $ref: '#/definitions/HealthStatus' 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 Status: title: Status description: Describe the current state of the API enum: - NotStarted - Running - Succeeded - Failed type: string readOnly: true x-ms-enum: name: Status modelAsString: false values: - value: NotStarted description: The long running operation has not yet started. - value: Running description: The long running operation is currently processing. - value: Succeeded description: The long running operation has successfully completed. - value: Failed description: The long running operation has failed. Transcription: title: Transcription required: - displayName - locale type: object properties: links: $ref: '#/definitions/Links' properties: $ref: '#/definitions/TranscriptionProperties' self: format: uri description: The location of this entity. type: string readOnly: true model: $ref: '#/definitions/EntityReference' project: $ref: '#/definitions/EntityReference' dataset: $ref: '#/definitions/EntityReference' contentUrls: description: "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response." type: array items: format: uri type: string contentContainerUrl: format: uri description: "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response." type: string 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: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true TranscriptionProperties: title: TranscriptionProperties type: object properties: diarizationEnabled: description: "A value indicating whether diarization (speaker identification) is requested. The default value\r\nis `false`." type: boolean wordLevelTimestampsEnabled: description: "A value indicating whether word level timestamps are requested. The default value is\r\n`false`." type: boolean duration: description: "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string readOnly: true channels: description: "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered." type: array items: format: int32 type: integer destinationContainerUrl: format: uri description: "The requested destination container.\r\n### Remarks ###\r\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\r\ntranscription will be deleted normally, but the data stored in the destination container, including\r\ntranscription results, will remain untouched, because no delete permissions are required for this\r\ncontainer.
\r\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\r\ninstead of `destinationContainerUrl`, where blobs can be cleaned up." type: string punctuationMode: $ref: '#/definitions/PunctuationMode' profanityFilterMode: $ref: '#/definitions/ProfanityFilterMode' timeToLive: description: "How long the transcription will be kept in the system after it has completed. Once the\r\ntranscription reaches the time to live after completion (successful or failed) it will be automatically\r\ndeleted. Not setting this value or setting it to 0 will disable automatic deletion. The longest supported\r\nduration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' TranscriptionUpdate: title: TranscriptionUpdate type: object properties: project: $ref: '#/definitions/EntityReference' displayName: description: The name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string WebHook: title: WebHook required: - displayName - events - webUrl type: object properties: webUrl: format: uri description: >- The registered URL that will be used to send the POST requests for the registered events to. type: string links: $ref: '#/definitions/WebHookLinks' properties: $ref: '#/definitions/WebHookProperties' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string events: $ref: '#/definitions/WebHookEvents' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string WebHookEvents: title: WebHookEvents type: object properties: datasetCreation: type: boolean datasetProcessing: type: boolean datasetCompletion: type: boolean datasetDeletion: type: boolean modelCreation: type: boolean modelProcessing: type: boolean modelCompletion: type: boolean modelDeletion: type: boolean evaluationCreation: type: boolean evaluationProcessing: type: boolean evaluationCompletion: type: boolean evaluationDeletion: type: boolean transcriptionCreation: type: boolean transcriptionProcessing: type: boolean transcriptionCompletion: type: boolean transcriptionDeletion: type: boolean endpointCreation: type: boolean endpointProcessing: type: boolean endpointCompletion: type: boolean endpointDeletion: type: boolean ping: type: boolean challenge: type: boolean WebHookLinks: title: WebHookLinks type: object properties: ping: format: uri description: >- The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. type: string readOnly: true test: format: uri description: >- The URL that can be used sending test events to the registered URL of a web hook registration. type: string readOnly: true WebHookProperties: title: WebHookProperties type: object properties: error: $ref: '#/definitions/EntityError' apiVersion: description: "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\r\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\r\nthe web hook will be disabled." type: string readOnly: true secret: description: "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL." type: string WebHookPropertiesUpdate: title: WebHookPropertiesUpdate type: object properties: secret: description: "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL." type: string WebHookUpdate: title: WebHookUpdate type: object properties: webUrl: format: uri description: >- The registered URL that will be used to send the POST requests for the registered events to. type: string properties: $ref: '#/definitions/WebHookPropertiesUpdate' events: $ref: '#/definitions/WebHookEvents' displayName: description: The name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string parameters: Endpoint: in: path name: Endpoint description: >- Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). required: true type: string x-ms-skip-url-encoding: true x-ms-parameter-location: client skipQueryParameter: in: query name: skip description: Number of datasets that will be skipped. type: integer format: int32 x-ms-parameter-location: method topQueryParameter: in: query name: top description: Number of datasets that will be included after skipping. type: integer format: int32 x-ms-parameter-location: method sasValidityQueryParameter: in: query name: sasValidityInSeconds description: "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.\r\n When using BYOS (https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated." type: integer format: int32 x-ms-parameter-location: method securityDefinitions: api_key: type: apiKey name: Ocp-Apim-Subscription-Key in: header description: Provide your cognitive services account key here. token: type: apiKey name: Authorization in: header description: >- Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement security: - api_key: [] - token: [] schemes: - https x-ms-parameterized-host: hostTemplate: '{Endpoint}/speechtotext/v3.0' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint' tags: - name: 'Custom Speech Datasets for Model Adaptation:' - name: 'Custom Speech Endpoints:' - name: 'Custom Speech Model Evaluations:' - name: 'Custom Speech Models:' - name: 'Custom Speech Projects:' - name: 'Custom Speech Transcriptions:' - name: 'Custom Speech Web Hooks:' - name: 'Service Health:'