{ "swagger": "2.0", "info": { "title": "Speech Services API version 2024-11-15", "description": "Speech Services API version 2024-11-15.", "contact": { "name": "Cognitive Services - Speech Services", "url": "https://learn.microsoft.com/azure/cognitive-services/speech-service/support" }, "version": "2024-11-15" }, "paths": { "/datasets/locales": { "get": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Gets a list of supported locales for datasets.", "operationId": "Datasets_ListSupportedLocales", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DatasetLocales" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_dataset_locales.json" } } } }, "/datasets": { "get": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Gets a list of datasets for the authenticated subscription.", "operationId": "Datasets_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n -Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedDatasets" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all datasets": { "$ref": "./examples/get_datasets.json" }, "Get all acoustic datasets": { "$ref": "./examples/get_acoustic_datasets.json" } } }, "post": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Uploads and creates a new dataset by getting the data from a specified URL or starts waiting for data blocks to be uploaded.", "operationId": "Datasets_Create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "dataset", "description": "Definition for the new dataset.", "required": true, "schema": { "$ref": "#/definitions/Dataset" } } ], "responses": { "201": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/Dataset" }, "headers": { "Location": { "description": "The location of the created resource.", "type": "string", "format": "uri" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Create a dataset with content url": { "$ref": "./examples/create_dataset_with_content_url.json" }, "Create dataset from data blocks": { "$ref": "./examples/create_dataset_with_blocks.json" } } } }, "/datasets/{id}": { "get": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Gets the dataset identified by the given ID.", "operationId": "Datasets_Get", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Dataset" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a dataset": { "$ref": "./examples/get_dataset.json" } } }, "patch": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Updates the mutable details of the dataset identified by its ID.", "operationId": "Datasets_Update", "consumes": [ "application/json", "application/merge-patch+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "datasetUpdate", "description": "The updated values for the dataset.", "required": true, "schema": { "$ref": "#/definitions/DatasetUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Dataset" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Update a dataset": { "$ref": "./examples/update_dataset.json" } } }, "delete": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Deletes the specified dataset.", "operationId": "Datasets_Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "204": { "description": "The dataset was successfully deleted or did not exist." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Delete a dataset": { "$ref": "./examples/delete_dataset.json" } } } }, "/datasets/{id}/blocks": { "get": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Gets the list of uploaded blocks for this dataset.", "operationId": "Datasets_GetBlocks", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UploadedBlocks" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get uploaded blocks for dataset": { "$ref": "./examples/get_dataset_blocks.json" } } }, "put": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Upload a block of data for the dataset. The maximum size of the block is 8MiB.", "operationId": "Datasets_UploadBlock", "consumes": [ "application/octet-stream" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "blockid", "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. Note that the Base64 string must be URL-encoded.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "body", "required": true, "schema": { "format": "binary", "type": "string" } } ], "responses": { "201": { "description": "The data block was uploaded successfully." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Upload a block for a dataset": { "$ref": "./examples/upload_block.json" } } } }, "/datasets/{id}/blocks:commit": { "post": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Commit block list to complete the upload of the dataset.", "operationId": "Datasets_CommitBlocks", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "blockList", "description": "The list of blocks that compile the dataset.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/CommitBlocksEntry" } } } ], "responses": { "200": { "description": "The block list is accepted and the data import process can continue." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Commit uploaded blocks to dataset": { "$ref": "./examples/commit_block_list.json" } } } }, "/datasets/{id}/files": { "get": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Gets the files of the dataset identified by the given ID.", "operationId": "Datasets_ListFiles", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/sasLifetimeQueryParameter" }, { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedFiles" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all files": { "$ref": "./examples/get_dataset_files.json" }, "Get all dataset report files": { "$ref": "./examples/get_dataset_report_files.json" } } } }, "/datasets/{id}/files/{fileId}": { "get": { "tags": [ "Custom Speech datasets for model adaptation:" ], "summary": "Gets one specific file (identified with fileId) from a dataset (identified with id).", "operationId": "Datasets_GetFile", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the dataset.", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "fileId", "description": "The identifier of the file.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/sasLifetimeQueryParameter" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/File" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a file": { "$ref": "./examples/get_dataset_file.json" } } } }, "/endpoints/locales": { "get": { "tags": [ "Custom Speech endpoints:" ], "summary": "Gets a list of supported locales for endpoint creations.", "operationId": "Endpoints_ListSupportedLocales", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_endpoint_locales.json" } } } }, "/endpoints": { "get": { "tags": [ "Custom Speech endpoints:" ], "summary": "Gets the list of endpoints for the authenticated subscription.", "operationId": "Endpoints_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedEndpoints" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all endpoints": { "$ref": "./examples/get_endpoints.json" }, "Get all queued endpoints.": { "$ref": "./examples/get_not_started_endpoints.json" } } }, "post": { "tags": [ "Custom Speech endpoints:" ], "summary": "Creates a new endpoint.", "operationId": "Endpoints_Create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "endpoint", "description": "The details of the endpoint.", "required": true, "schema": { "$ref": "#/definitions/Endpoint" } } ], "responses": { "201": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": { "Location": { "description": "The location of the created resource.", "type": "string", "format": "uri" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Create an endpoint": { "$ref": "./examples/create_endpoint.json" } } } }, "/endpoints/{id}": { "get": { "tags": [ "Custom Speech endpoints:" ], "summary": "Gets the endpoint identified by the given ID.", "operationId": "Endpoints_Get", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the endpoint.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get an endpoint": { "$ref": "./examples/get_endpoint.json" } } }, "delete": { "tags": [ "Custom Speech endpoints:" ], "summary": "Deletes the endpoint identified by the given ID.", "operationId": "Endpoints_Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the endpoint.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "204": { "description": "The model endpoint was successfully deleted." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Delete an endpoint": { "$ref": "./examples/delete_endpoint.json" } } }, "patch": { "tags": [ "Custom Speech endpoints:" ], "summary": "Updates the metadata of the endpoint identified by the given ID.", "operationId": "Endpoints_Update", "consumes": [ "application/json", "application/merge-patch+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the endpoint.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "endpointUpdate", "description": "The updated values for the endpoint.", "required": true, "schema": { "$ref": "#/definitions/EndpointUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Update an endpoint": { "$ref": "./examples/update_endpoint.json" } } } }, "/evaluations/locales": { "get": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Gets a list of supported locales for evaluations.", "operationId": "Evaluations_ListSupportedLocales", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_evaluations_locales.json" } } } }, "/evaluations": { "get": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Gets the list of evaluations for the authenticated subscription.", "operationId": "Evaluations_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My evaluation'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedEvaluations" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all evaluations": { "$ref": "./examples/get_evaluations.json" }, "Get all evaluations with where status is equal to 'Running'": { "$ref": "./examples/get_evaluations_with_status_running.json" } } }, "post": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Creates a new evaluation.", "operationId": "Evaluations_Create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "evaluation", "description": "The details of the new evaluation.", "required": true, "schema": { "$ref": "#/definitions/Evaluation" } } ], "responses": { "201": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/Evaluation" }, "headers": { "Location": { "description": "The location of the created resource.", "type": "string", "format": "uri" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Create a evaluation": { "$ref": "./examples/create_evaluation.json" } } } }, "/evaluations/{id}/files": { "get": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Gets the files of the evaluation identified by the given ID.", "operationId": "Evaluations_ListFiles", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the evaluation.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/sasLifetimeQueryParameter" }, { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedFiles" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all files": { "$ref": "./examples/get_evaluation_files.json" } } } }, "/evaluations/{id}/files/{fileId}": { "get": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Gets one specific file (identified with fileId) from an evaluation (identified with id).", "operationId": "Evaluations_GetFile", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the evaluation.", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "fileId", "description": "The identifier of the file.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/sasLifetimeQueryParameter" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/File" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a file": { "$ref": "./examples/get_evaluation_file.json" } } } }, "/evaluations/{id}": { "get": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Gets the evaluation identified by the given ID.", "operationId": "Evaluations_Get", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the evaluation.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Evaluation" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a evaluation": { "$ref": "./examples/get_evaluation.json" } } }, "patch": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Updates the mutable details of the evaluation identified by its id.", "operationId": "Evaluations_Update", "consumes": [ "application/json", "application/merge-patch+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the evaluation.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "evaluationUpdate", "description": "The object containing the updated fields of the evaluation.", "required": true, "schema": { "$ref": "#/definitions/EvaluationUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Evaluation" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Update a evaluation": { "$ref": "./examples/update_evaluation.json" } } }, "delete": { "tags": [ "Custom Speech model evaluations:" ], "summary": "Deletes the evaluation identified by the given ID.", "operationId": "Evaluations_Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the evaluation.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "204": { "description": "The evaluation was successfully deleted or did not exist." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Delete a evaluation": { "$ref": "./examples/delete_evaluation.json" } } } }, "/models/locales": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Gets a list of supported locales for model adaptation.", "operationId": "Models_ListSupportedLocales", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_model_locales.json" } } } }, "/models": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Gets the list of custom models for the authenticated subscription.", "operationId": "Models_ListCustomModels", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedCustomModels" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all models in state 'Running'": { "$ref": "./examples/get_running_models.json" } } }, "post": { "tags": [ "Custom Speech models:" ], "summary": "Creates a new model.", "operationId": "Models_Create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "model", "description": "The details of the new model.", "required": true, "schema": { "$ref": "#/definitions/CustomModel" } } ], "responses": { "201": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/CustomModel" }, "headers": { "Location": { "description": "The location of the created resource.", "type": "string", "format": "uri" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Create a model": { "$ref": "./examples/create_model.json" }, "Create a model with custom model weight": { "$ref": "./examples/create_model_with_weight.json" } } } }, "/models/base": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Gets the list of base models for the authenticated subscription.", "operationId": "Models_ListBaseModels", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available base models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedBaseModels" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all english base models": { "$ref": "./examples/get_english_base_models.json" } } } }, "/models/{id}": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Gets the model identified by the given ID.", "operationId": "Models_GetCustomModel", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the model.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomModel" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a model": { "$ref": "./examples/get_model.json" }, "Get a model with custom model weight": { "$ref": "./examples/get_model_with_weight.json" } } }, "patch": { "tags": [ "Custom Speech models:" ], "summary": "Updates the metadata of the model identified by the given ID.", "operationId": "Models_Update", "consumes": [ "application/json", "application/merge-patch+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the model.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "modelUpdate", "description": "The updated values for the model.", "required": true, "schema": { "$ref": "#/definitions/ModelUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomModel" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Update a model": { "$ref": "./examples/update_model.json" } } }, "delete": { "tags": [ "Custom Speech models:" ], "summary": "Deletes the model identified by the given ID.", "operationId": "Models_Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the model.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "204": { "description": "The model was successfully deleted or did not exist." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Delete a model": { "$ref": "./examples/delete_model.json" } } } }, "/models/base/{id}": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Gets the base model identified by the given ID.", "operationId": "Models_GetBaseModel", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the base model.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BaseModel" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a base model": { "$ref": "./examples/get_base_model.json" } } } }, "/models/{id}:copy": { "post": { "tags": [ "Custom Speech models:" ], "summary": "Copies a model from one subscription to another.", "description": "This method can be used to copy a model from this speech resource to a target one.\r\nThe authorization is obtained on the target speech resource.\r\nOnly custom models can be copied to another speech resource.", "operationId": "Models_Copy", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the model that will be copied.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "modelCopyAuthorization", "description": "The body contains the authorization to copy to the target speech resource.", "required": true, "schema": { "$ref": "#/definitions/ModelCopyAuthorization" } } ], "responses": { "202": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", "type": "integer", "format": "int32" }, "Operation-Location": { "description": "The location of the operation to track progress.", "type": "string", "format": "uri" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Copy a model from source resource to target resource": { "$ref": "./examples/copy_model_with_authorization.json" } } } }, "/models:authorizecopy": { "post": { "tags": [ "Custom Speech models:" ], "summary": "Allows another speech resource (source) to copy a model to this speech resource (target).", "description": "This method can be used to allow copying a model from another speech resource.\r\nOnly custom models can be copied from another speech resource.", "operationId": "Models_AuthorizeCopy", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "modelCopyAuthorizationDefinition", "description": "The body contains the Azure Resource ID of the source speech resource.", "required": true, "schema": { "$ref": "#/definitions/ModelCopyAuthorizationDefinition" } } ], "responses": { "200": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/ModelCopyAuthorization" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Create a copy model authorization on target resource": { "$ref": "./examples/create_copy_model_authorization.json" } } } }, "/models/{id}/manifest": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Returns an manifest for this model which can be used in an on-premise container.", "operationId": "Models_GetCustomModelManifest", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The ID of the model to generate a manifest for.", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "sasLifetimeMinutes", "description": "The duration in minutes that an SAS url should be valid.", "required": true, "type": "integer", "format": "int32" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "Successfully generated a model manifest.", "schema": { "$ref": "#/definitions/ModelManifest" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a model manifest": { "$ref": "./examples/get_model_manifest.json" } } } }, "/models/base/{id}/manifest": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Returns an manifest for this base model which can be used in an on-premise container.", "operationId": "Models_GetBaseModelManifest", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The ID of the model to generate a manifest for.", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "sasLifetimeMinutes", "description": "The duration in minutes that an SAS url should be valid.", "required": true, "type": "integer", "format": "int32" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "Successfully generated a model manifest.", "schema": { "$ref": "#/definitions/ModelManifest" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a base model manifest": { "$ref": "./examples/get_base_model_manifest.json" } } } }, "/models/{id}/files": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Gets the files of the model identified by the given ID.", "operationId": "Models_ListFiles", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the model.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/sasLifetimeQueryParameter" }, { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedFiles" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all files": { "$ref": "./examples/get_model_files.json" } } } }, "/models/{id}/files/{fileId}": { "get": { "tags": [ "Custom Speech models:" ], "summary": "Gets one specific file (identified with fileId) from a model (identified with id).", "operationId": "Models_GetFile", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the model.", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "fileId", "description": "The identifier of the file.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/sasLifetimeQueryParameter" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/File" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a file": { "$ref": "./examples/get_model_file.json" } } } }, "/operations/models/copy/{id}": { "get": { "tags": [ "Custom Speech operations:" ], "summary": "Gets the operation identified by the given ID.", "operationId": "Operations_GetModelCopy", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the operation.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get model copy operation pending": { "$ref": "./examples/get_operation_copy_model_pending.json" }, "Get model copy operation": { "$ref": "./examples/get_operation_copy_model.json" } } } }, "/transcriptions/locales": { "get": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Gets a list of supported locales for offline transcriptions.", "operationId": "Transcriptions_ListSupportedLocales", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TranscriptionLocales" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get the supported locales": { "$ref": "./examples/get_supported_transcription_locales.json" } } } }, "/transcriptions": { "get": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Gets a list of transcriptions for the authenticated subscription.", "operationId": "Transcriptions_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedTranscriptions" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all transcriptions": { "$ref": "./examples/get_transcriptions.json" }, "Get all failed transcriptions": { "$ref": "./examples/get_failed_transcriptions.json" } } } }, "/transcriptions/{id}": { "get": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Gets the transcription identified by the given ID.", "operationId": "Transcriptions_Get", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the transcription.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Transcription" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a transcription": { "$ref": "./examples/get_transcription.json" } } }, "patch": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Updates the mutable details of the transcription identified by its ID.", "operationId": "Transcriptions_Update", "consumes": [ "application/json", "application/merge-patch+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the transcription.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "transcriptionUpdate", "description": "The updated values for the transcription.", "required": true, "schema": { "$ref": "#/definitions/TranscriptionUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Transcription" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Update a transcription": { "$ref": "./examples/update_transcription.json" } } }, "delete": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Deletes the specified transcription task.", "operationId": "Transcriptions_Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the transcription.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "204": { "description": "The transcription was successfully deleted or did not exist." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Delete a transcription": { "$ref": "./examples/delete_transcription.json" } } } }, "/transcriptions:submit": { "post": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Submits a new transcription job.", "operationId": "Transcriptions_Submit", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "transcription", "description": "The details of the new transcription.", "required": true, "schema": { "$ref": "#/definitions/Transcription" } } ], "responses": { "201": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/Transcription" }, "headers": { "Location": { "description": "The location of the created resource.", "type": "string", "format": "uri" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Create a transcription for URIs": { "$ref": "./examples/create_uri_transcription.json" }, "Create a transcription with multispeaker diarization": { "$ref": "./examples/create_multispeaker_diarization_transcription.json" }, "Create a transcription with language identification": { "$ref": "./examples/create_lid_transcription.json" }, "Create a transcription from blob container": { "$ref": "./examples/create_container_transcription.json" } } } }, "/transcriptions/{id}/files": { "get": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Gets the files of the transcription identified by the given ID.", "operationId": "Transcriptions_ListFiles", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the transcription.", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "sasLifetimeMinutes", "description": "This parameter defines the duration in minutes for which an SAS url should be valid.\r\n The parameter can only be used for operations on speech resources that don't have BYOS enabled and transcriptions without a destinationContainerUrl. For speech resources\r\n that don't have BYOS enabled, the default SAS validity duration is 12 hours.\r\n For speech resources with BYOS and transcriptions with a destinationContainerUrl, returned urls do not contain an SAS token.", "type": "integer", "format": "int32" }, { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav.json' and kind eq 'Transcription'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedFiles" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all files": { "$ref": "./examples/get_transcription_files.json" }, "Get all transcription files the name of which starts with the specified string": { "$ref": "./examples/get_transcription_files_filtered_by_name.json" } } } }, "/transcriptions/{id}/files/{fileId}": { "get": { "tags": [ "Custom Speech transcriptions:" ], "summary": "Gets one specific file (identified with fileId) from a transcription (identified with id).", "operationId": "Transcriptions_GetFile", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the transcription.", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "fileId", "description": "The identifier of the file.", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "sasLifetimeMinutes", "description": "This parameter defines the duration in minutes for which an SAS url should be valid.\r\n The parameter can only be used for operations on speech resources that don't have BYOS enabled and transcriptions without a destinationContainerUrl. For speech resources\r\n that don't have BYOS enabled, the default SAS validity duration is 12 hours.\r\n For speech resources with BYOS and transcriptions with a destinationContainerUrl, returned urls do not contain an SAS token.", "type": "integer", "format": "int32" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/File" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a file": { "$ref": "./examples/get_transcription_file.json" } } } }, "/webhooks": { "get": { "tags": [ "Custom Speech web hooks:" ], "summary": "Gets the list of web hooks for the authenticated subscription.", "operationId": "WebHooks_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/skipQueryParameter" }, { "$ref": "#/parameters/topQueryParameter" }, { "in": "query", "name": "filter", "description": "A filtering expression for selecting a subset of the available hooks.\r\n Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'test'", "type": "string" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaginatedWebHooks" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-pageable": { "itemName": "values", "nextLinkName": "@nextLink" }, "x-ms-examples": { "Get all web hooks": { "$ref": "./examples/get_web_hooks.json" }, "Get all web hooks created in 03/2020 ordered by their name": { "$ref": "./examples/get_web_hooks_from_march_2020.json" } } }, "post": { "tags": [ "Custom Speech web hooks:" ], "summary": "Creates a new web hook.", "description": "If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with\r\nthe secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nWhen calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event\r\ntypes. There will be one request per registered event type.\r\n \r\nAfter successfully registering the web hook, it will not be usable until a challenge/response is completed. To do this, a request with the event type\r\nchallenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken\r\nquery parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.", "operationId": "WebHooks_Create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "webHook", "description": "The details of the new web hook.", "required": true, "schema": { "$ref": "#/definitions/WebHook" } } ], "responses": { "201": { "description": "The response contains information about the entity as payload and its location as header.", "schema": { "$ref": "#/definitions/WebHook" }, "headers": { "Location": { "description": "The location of the created resource.", "type": "string", "format": "uri" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Create a web hook": { "$ref": "./examples/create_web_hook.json" } } } }, "/webhooks/{id}": { "get": { "tags": [ "Custom Speech web hooks:" ], "summary": "Gets the web hook identified by the given ID.", "operationId": "WebHooks_Get", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the web hook.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WebHook" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Get a web hook": { "$ref": "./examples/get_web_hook.json" } } }, "patch": { "tags": [ "Custom Speech web hooks:" ], "summary": "Updates the web hook identified by the given ID.", "description": "If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature\r\nheaders. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash\r\nwill be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nIf the URL changes, the web hook will stop receiving events until a\r\nchallenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken.\r\nRespond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response\r\nis successfully completed, the web hook will begin receiving events.", "operationId": "WebHooks_Update", "consumes": [ "application/json", "application/merge-patch+json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the web hook.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "body", "name": "webHookUpdate", "description": "The updated values for the web hook.", "required": true, "schema": { "$ref": "#/definitions/WebHookUpdate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WebHook" }, "headers": { "Retry-After": { "description": "The minimum number of seconds to wait for a non terminal operation to complete.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Update a web hook": { "$ref": "./examples/update_web_hook.json" } } }, "delete": { "tags": [ "Custom Speech web hooks:" ], "summary": "Deletes the web hook identified by the given ID.", "operationId": "WebHooks_Delete", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the web hook.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "204": { "description": "The web hook was successfully deleted." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Delete a web hook": { "$ref": "./examples/delete_web_hook.json" } } } }, "/webhooks/{id}:ping": { "post": { "tags": [ "Custom Speech web hooks:" ], "summary": "Sends a ping event to the registered URL.", "description": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.\r\nThe Swagger Schema ID of the model is WebHookV3.\r\n \r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with\r\na secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", "operationId": "WebHooks_Ping", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the web hook to ping.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "202": { "description": "Started trying to send a ping request to the web hook.", "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", "type": "integer", "format": "int32" } } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Ping a web hook": { "$ref": "./examples/ping_web_hook.json" } } } }, "/webhooks/{id}:test": { "post": { "tags": [ "Custom Speech web hooks:" ], "summary": "Sends a request for each registered event type to the registered URL.", "description": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,\r\nthe POST will respond with 204. If a test request can be made, it will respond with 200.\r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.\r\nIf the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", "operationId": "WebHooks_Test", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The identifier of the web hook to ping.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionQueryParameter" } ], "responses": { "202": { "description": "A test request with the last entity is sent to the registered web hook.", "headers": { "Retry-After": { "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", "type": "integer", "format": "int32" } } }, "204": { "description": "No entity could be found for any event type, so no test request is sent to the registered web hook." }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Test a web hook": { "$ref": "./examples/test_web_hook.json" } } } }, "/transcriptions:transcribe": { "post": { "tags": [ "Transcribe" ], "summary": "Synchronous transcription of an audio file.", "operationId": "Transcriptions_Transcribe", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/apiVersionQueryParameter" }, { "in": "formData", "name": "audio", "description": "The content of the audio file to be transcribed. The audio file must be shorter than 2 hours in audio duration and smaller than 250 MB in size.", "required": true, "type": "file", "format": "binary" }, { "in": "formData", "name": "definition", "description": "Metadata for a transcription request. This field contains a JSON-serialized object of type `TranscribeDefinition`.", "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TranscribeResult" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { "Transcribe an audio file": { "$ref": "./examples/transcribe_file.json" } } } } }, "definitions": { "BaseModel": { "title": "BaseModel", "required": [ "displayName", "locale" ], "type": "object", "allOf": [ { "$ref": "#/definitions/SharedModel" } ], "properties": { "links": { "$ref": "#/definitions/BaseModelLinks" }, "properties": { "$ref": "#/definitions/BaseModelProperties" } } }, "BaseModelDeprecationDates": { "title": "BaseModelDeprecationDates", "type": "object", "properties": { "adaptationDateTime": { "format": "date-time", "description": "The date when adaptation becomes deprecated.", "type": "string", "readOnly": true }, "transcriptionDateTime": { "format": "date-time", "description": "The date when transcription becomes deprecated.", "type": "string", "readOnly": true } } }, "BaseModelFeatures": { "title": "BaseModelFeatures", "description": "Features supported by the model.", "type": "object", "allOf": [ { "$ref": "#/definitions/SharedModelFeatures" } ], "properties": { "supportsAdaptationsWith": { "description": "Supported dataset kinds to adapt the model.", "type": "array", "items": { "$ref": "#/definitions/DatasetKind" }, "readOnly": true } } }, "BaseModelLinks": { "title": "BaseModelLinks", "type": "object", "properties": { "manifest": { "format": "uri", "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", "type": "string", "readOnly": true } } }, "BaseModelProperties": { "title": "BaseModelProperties", "type": "object", "properties": { "deprecationDates": { "$ref": "#/definitions/BaseModelDeprecationDates" }, "features": { "$ref": "#/definitions/BaseModelFeatures" }, "chargeForAdaptation": { "description": "A value indicating whether model adaptation is charged.", "type": "boolean", "readOnly": true } } }, "BlockKind": { "title": "BlockKind", "description": "Type of data block.", "enum": [ "Committed", "Uncommitted", "Latest" ], "type": "string", "x-ms-enum": { "name": "BlockKind", "modelAsString": true, "values": [ { "value": "Committed", "description": "A data block from the committed block list." }, { "value": "Uncommitted", "description": "A data block from the uncommitted block list." }, { "value": "Latest", "description": "A data block from the uncommitted block list, if present, otherwise from the committed block list." } ] } }, "CommitBlocksEntry": { "title": "CommitBlocksEntry", "description": "Entry of the commit block list.", "type": "object", "properties": { "kind": { "$ref": "#/definitions/BlockKind" }, "id": { "type": "string" } } }, "CustomModel": { "title": "CustomModel", "required": [ "displayName", "locale" ], "type": "object", "allOf": [ { "$ref": "#/definitions/SharedModel" } ], "properties": { "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } }, "baseModel": { "$ref": "#/definitions/EntityReference" }, "datasets": { "description": "Datasets used for adaptation.", "type": "array", "items": { "$ref": "#/definitions/EntityReference" } }, "links": { "$ref": "#/definitions/CustomModelLinks" }, "properties": { "$ref": "#/definitions/CustomModelProperties" } } }, "CustomModelDeprecationDates": { "title": "CustomModelDeprecationDates", "type": "object", "properties": { "transcriptionDateTime": { "format": "date-time", "description": "The date when transcription becomes deprecated.", "type": "string", "readOnly": true } }, "readOnly": true }, "CustomModelFeatures": { "title": "CustomModelFeatures", "description": "Features supported by the model.", "type": "object", "allOf": [ { "$ref": "#/definitions/SharedModelFeatures" } ], "readOnly": true }, "CustomModelLinks": { "title": "CustomModelLinks", "type": "object", "properties": { "manifest": { "format": "uri", "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", "type": "string", "readOnly": true }, "copy": { "format": "uri", "description": "The location to the model copy action. See operation \"Models_Copy\" for more details.", "type": "string", "readOnly": true }, "files": { "format": "uri", "description": "The location to get all files of this entity. See operation \"Models_ListFiles\" for more details.", "type": "string", "readOnly": true } }, "readOnly": true }, "CustomModelProperties": { "title": "CustomModelProperties", "type": "object", "properties": { "deprecationDates": { "$ref": "#/definitions/CustomModelDeprecationDates" }, "customModelWeightPercent": { "format": "int32", "description": "The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model).\nWhen this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight).\nStart without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model.", "maximum": 100, "minimum": 1, "type": "integer" }, "features": { "$ref": "#/definitions/CustomModelFeatures" }, "error": { "$ref": "#/definitions/EntityError" } } }, "Dataset": { "title": "Dataset", "required": [ "displayName", "locale", "kind" ], "type": "object", "properties": { "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "displayName": { "description": "The display name of the object.", "minLength": 1, "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } }, "locale": { "description": "The locale of the contained data.", "minLength": 1, "type": "string" }, "createdDateTime": { "format": "date-time", "description": "The time-stamp when the object was created.\nThe time stamp is encoded as ISO 8601 date and time format\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.\nThe time stamp is encoded as ISO 8601 date and time format\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", "type": "string", "readOnly": true }, "kind": { "$ref": "#/definitions/DatasetKind" }, "links": { "$ref": "#/definitions/DatasetLinks" }, "properties": { "$ref": "#/definitions/DatasetProperties" }, "contentUrl": { "format": "uri", "description": "The URL of the data for the dataset.", "type": "string" }, "status": { "$ref": "#/definitions/Status" } } }, "DatasetKind": { "title": "DatasetKind", "description": "Type of data import.", "enum": [ "Language", "Acoustic", "Pronunciation", "AudioFiles", "LanguageMarkdown", "OutputFormatting" ], "type": "string", "x-ms-enum": { "name": "DatasetKind", "modelAsString": true, "values": [ { "value": "Language", "description": "A language dataset." }, { "value": "Acoustic", "description": "An acoustic dataset." }, { "value": "Pronunciation", "description": "A pronunciation dataset." }, { "value": "AudioFiles", "description": "An audio files dataset." }, { "value": "LanguageMarkdown", "description": "A language markdown dataset." }, { "value": "OutputFormatting", "description": "Dataset that contains rules to customize inverse text normalization, capitalization, reformulation, profanity and also defines tests for dataset validation" } ] } }, "DatasetLinks": { "title": "DatasetLinks", "type": "object", "properties": { "files": { "format": "uri", "description": "The location to get all files of this entity. See operation \"Datasets_ListFiles\" for more details.", "type": "string", "readOnly": true }, "commitBlocks": { "format": "uri", "description": "The location to commit the list of blocks when uploading a dataset using blocks. See operation \"Datasets_CommitBlocks\" for more details.", "type": "string", "readOnly": true }, "listBlocks": { "format": "uri", "description": "The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation \"Datasets_GetBlocks\" for more details.", "type": "string", "readOnly": true }, "uploadBlocks": { "format": "uri", "description": "The location to upload blocks to when uploading a dataset using blocks. See operation \"Datasets_UploadBlock\" for more details.", "type": "string", "readOnly": true } }, "readOnly": true }, "DatasetLocales": { "title": "DatasetLocales", "type": "object", "properties": { "Language": { "type": "array", "items": { "type": "string" } }, "Acoustic": { "type": "array", "items": { "type": "string" } }, "Pronunciation": { "type": "array", "items": { "type": "string" } }, "AudioFiles": { "type": "array", "items": { "type": "string" } }, "LanguageMarkdown": { "type": "array", "items": { "type": "string" } }, "OutputFormatting": { "type": "array", "items": { "type": "string" } } } }, "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 }, "durationMilliseconds": { "format": "int64", "description": "The total duration in milliseconds of the datasets if it contains audio files.\nDurations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers.", "default": 0, "type": "integer", "readOnly": true }, "textNormalizationKind": { "$ref": "#/definitions/TextNormalizationKind" }, "error": { "$ref": "#/definitions/EntityError" } } }, "DatasetUpdate": { "title": "DatasetUpdate", "type": "object", "properties": { "displayName": { "description": "The name of the object.", "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\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", "InvalidChannels", "ModelMismatch", "ProjectGenderMismatch", "ModelDeprecated", "ModelExists", "ModelNotDeployable", "EndpointNotUpdatable", "SingleDefaultEndpoint", "EndpointCannotBeDefault", "InvalidModelUri", "SubscriptionNotFound", "QuotaViolation", "UnsupportedDelta", "UnsupportedFilter", "UnsupportedPagination", "UnsupportedDynamicConfiguration", "UnsupportedOrderBy", "NoUtf8WithBom", "ModelDeploymentNotCompleteState", "SkuLimitsExist", "DeployingFailedModel", "UnsupportedTimeRange", "InvalidLogDate", "InvalidLogId", "InvalidLogStartTime", "InvalidLogEndTime", "InvalidTopForLogs", "InvalidSkipTokenForLogs", "DeleteNotAllowed", "Forbidden", "DeployNotAllowed", "UnexpectedError", "InvalidCollection", "InvalidCallbackUri", "InvalidSasValidityDuration", "InaccessibleCustomerStorage", "UnsupportedClassBasedAdaptation", "InvalidWebHookEventKind", "InvalidTimeToLive", "InvalidSourceAzureResourceId", "ModelCopyAuthorizationExpired", "EndpointLoggingNotSupported", "NoLanguageIdentified", "MultipleLanguagesIdentified", "InvalidAudioFormat", "BadChannelConfiguration", "InvalidChannelSpecification", "AudioLengthLimitExceeded", "EmptyAudioFile" ], "type": "string", "x-ms-enum": { "name": "DetailedErrorCode", "modelAsString": true, "values": [ { "value": "InvalidParameterValue", "description": "Invalid parameter value." }, { "value": "InvalidRequestBodyFormat", "description": "Invalid request body format." }, { "value": "EmptyRequest", "description": "Empty Request." }, { "value": "MissingInputRecords", "description": "Missing Input Records." }, { "value": "InvalidDocument", "description": "Invalid Document." }, { "value": "ModelVersionIncorrect", "description": "Model Version Incorrect." }, { "value": "InvalidDocumentBatch", "description": "Invalid Document Batch." }, { "value": "UnsupportedLanguageCode", "description": "Unsupported language code." }, { "value": "DataImportFailed", "description": "Data import failed." }, { "value": "InUseViolation", "description": "In use violation." }, { "value": "InvalidLocale", "description": "Invalid locale." }, { "value": "InvalidBaseModel", "description": "Invalid base model." }, { "value": "InvalidAdaptationMapping", "description": "Invalid adaptation mapping." }, { "value": "InvalidDataset", "description": "Invalid dataset." }, { "value": "InvalidTest", "description": "Invalid test." }, { "value": "FailedDataset", "description": "Failed dataset." }, { "value": "InvalidModel", "description": "Invalid model." }, { "value": "InvalidTranscription", "description": "Invalid transcription." }, { "value": "InvalidPayload", "description": "Invalid payload." }, { "value": "InvalidParameter", "description": "Invalid parameter." }, { "value": "EndpointWithoutLogging", "description": "Endpoint without logging." }, { "value": "InvalidPermissions", "description": "Invalid permissions." }, { "value": "InvalidPrerequisite", "description": "Invalid prerequisite." }, { "value": "InvalidProductId", "description": "Invalid product id." }, { "value": "InvalidSubscription", "description": "Invalid subscription." }, { "value": "InvalidProject", "description": "Invalid project." }, { "value": "InvalidProjectKind", "description": "Invalid project kind." }, { "value": "InvalidRecordingsUri", "description": "Invalid recordings uri." }, { "value": "OnlyOneOfUrlsOrContainerOrDataset", "description": "Only one of urls or container or dataset." }, { "value": "ExceededNumberOfRecordingsUris", "description": "Exceeded number of recordings uris." }, { "value": "InvalidChannels", "description": "Invalid channels." }, { "value": "ModelMismatch", "description": "Model mismatch." }, { "value": "ProjectGenderMismatch", "description": "Project gender mismatch." }, { "value": "ModelDeprecated", "description": "Model deprecated." }, { "value": "ModelExists", "description": "Model exists." }, { "value": "ModelNotDeployable", "description": "Model not deployable." }, { "value": "EndpointNotUpdatable", "description": "Endpoint not updatable." }, { "value": "SingleDefaultEndpoint", "description": "Single default endpoint." }, { "value": "EndpointCannotBeDefault", "description": "Endpoint cannot be default." }, { "value": "InvalidModelUri", "description": "Invalid model uri." }, { "value": "SubscriptionNotFound", "description": "Subscription not found." }, { "value": "QuotaViolation", "description": "Quota violation." }, { "value": "UnsupportedDelta", "description": "Unsupported delta." }, { "value": "UnsupportedFilter", "description": "Unsupported filter." }, { "value": "UnsupportedPagination", "description": "Unsupported pagination." }, { "value": "UnsupportedDynamicConfiguration", "description": "Unsupported dynamic configuration." }, { "value": "UnsupportedOrderBy", "description": "Unsupported order by." }, { "value": "NoUtf8WithBom", "description": "No utf8 with bom." }, { "value": "ModelDeploymentNotCompleteState", "description": "Model deployment not complete state." }, { "value": "SkuLimitsExist", "description": "Sku limits exist." }, { "value": "DeployingFailedModel", "description": "Deploying failed model." }, { "value": "UnsupportedTimeRange", "description": "Unsupported time range." }, { "value": "InvalidLogDate", "description": "Invalid log date." }, { "value": "InvalidLogId", "description": "Invalid log id." }, { "value": "InvalidLogStartTime", "description": "Invalid log start time." }, { "value": "InvalidLogEndTime", "description": "Invalid log end time." }, { "value": "InvalidTopForLogs", "description": "Invalid top for logs." }, { "value": "InvalidSkipTokenForLogs", "description": "Invalid skip token for logs." }, { "value": "DeleteNotAllowed", "description": "Delete not allowed." }, { "value": "Forbidden", "description": "Forbidden." }, { "value": "DeployNotAllowed", "description": "Deploy not allowed." }, { "value": "UnexpectedError", "description": "Unexpected error." }, { "value": "InvalidCollection", "description": "Invalid collection." }, { "value": "InvalidCallbackUri", "description": "Invalid callback uri." }, { "value": "InvalidSasValidityDuration", "description": "Invalid sas validity duration." }, { "value": "InaccessibleCustomerStorage", "description": "Inaccessible customer storage." }, { "value": "UnsupportedClassBasedAdaptation", "description": "Unsupported class based adaptation." }, { "value": "InvalidWebHookEventKind", "description": "Invalid web hook event kind." }, { "value": "InvalidTimeToLive", "description": "Invalid time to live." }, { "value": "InvalidSourceAzureResourceId", "description": "Invalid source Azure resource ID." }, { "value": "ModelCopyAuthorizationExpired", "description": "Expired ModelCopyAuthorization." }, { "value": "EndpointLoggingNotSupported", "description": "Endpoint logging not supported." }, { "value": "NoLanguageIdentified", "description": "Language Identification did not recognize any language." }, { "value": "MultipleLanguagesIdentified", "description": "Language Identification recognized multiple languages. No dominant language could be determined." }, { "value": "InvalidAudioFormat", "description": "The format of input audio is not supported." }, { "value": "BadChannelConfiguration", "description": "There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application." }, { "value": "InvalidChannelSpecification", "description": "The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.)" }, { "value": "AudioLengthLimitExceeded", "description": "The audio file is longer than the maximum allowed duration." }, { "value": "EmptyAudioFile", "description": "The audio file is empty." } ] } }, "DiarizationProperties": { "title": "DiarizationProperties", "type": "object", "properties": { "enabled": { "description": "A value indicating whether speaker diarization is enabled.", "type": "boolean" }, "maxSpeakers": { "format": "int32", "description": "A hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36.", "maximum": 35, "minimum": 2, "type": "integer" } } }, "EditsSummary": { "title": "EditsSummary", "type": "object", "properties": { "numberOfEdits": { "format": "int32", "description": "The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription.", "type": "integer", "readOnly": true }, "percentageOfAllEdits": { "format": "double", "description": "The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription.", "type": "number", "readOnly": true } }, "readOnly": true }, "Endpoint": { "title": "Endpoint", "required": [ "displayName", "locale" ], "type": "object", "properties": { "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "model": { "$ref": "#/definitions/EntityReference" }, "displayName": { "description": "The display name of the object.", "minLength": 1, "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } }, "locale": { "description": "The locale of the contained data.", "minLength": 1, "type": "string" }, "createdDateTime": { "format": "date-time", "description": "The time-stamp when the object was created.\nThe time stamp is encoded as ISO 8601 date and time format\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.\nThe time stamp is encoded as ISO 8601 date and time format\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", "type": "string", "readOnly": true }, "properties": { "$ref": "#/definitions/EndpointProperties" }, "links": { "$ref": "#/definitions/EndpointLinks" }, "status": { "$ref": "#/definitions/Status" } } }, "EndpointLinks": { "title": "EndpointLinks", "type": "object", "properties": { "webSocket": { "format": "uri", "description": "The Speech SDK endpoint for long requests with multiple final results.", "type": "string", "readOnly": true } }, "readOnly": true }, "EndpointProperties": { "title": "EndpointProperties", "type": "object", "properties": { "loggingEnabled": { "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", "type": "boolean" }, "error": { "$ref": "#/definitions/EntityError" } } }, "EndpointPropertiesUpdate": { "title": "EndpointPropertiesUpdate", "type": "object", "properties": { "contentLoggingEnabled": { "description": "A value indicating whether content logging (audio & transcriptions)\nis being used for a deployment.", "type": "boolean" } } }, "EndpointUpdate": { "title": "EndpointUpdate", "type": "object", "properties": { "displayName": { "description": "The name of the object.", "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "model": { "$ref": "#/definitions/EntityReference" }, "properties": { "$ref": "#/definitions/EndpointPropertiesUpdate" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\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 } }, "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": "This error type contains an outer error with error code, message, details, target and an inner error with more descriptive details.", "type": "object", "properties": { "message": { "description": "High level error message.", "type": "string" }, "target": { "description": "The source of the error.\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", "type": "string" }, "innerError": { "$ref": "#/definitions/InnerError" }, "code": { "$ref": "#/definitions/ErrorCode" }, "details": { "description": "Additional supportive details regarding the error and/or expected policies.", "type": "array", "items": { "$ref": "#/definitions/Error" } } } }, "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": [ "displayName", "model1", "model2", "dataset", "locale" ], "type": "object", "properties": { "displayName": { "description": "The display name of the object.", "minLength": 1, "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } }, "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "createdDateTime": { "format": "date-time", "description": "The time-stamp when the object was created.\nThe time stamp is encoded as ISO 8601 date and time format\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.\nThe time stamp is encoded as ISO 8601 date and time format\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", "type": "string", "readOnly": true }, "model1": { "$ref": "#/definitions/EntityReference" }, "model2": { "$ref": "#/definitions/EntityReference" }, "dataset": { "$ref": "#/definitions/EntityReference" }, "transcription1": { "$ref": "#/definitions/EntityReference" }, "transcription2": { "$ref": "#/definitions/EntityReference" }, "links": { "$ref": "#/definitions/EvaluationLinks" }, "locale": { "description": "The locale of the contained data.", "minLength": 1, "type": "string" }, "properties": { "$ref": "#/definitions/EvaluationProperties" }, "status": { "$ref": "#/definitions/Status" } } }, "EvaluationLinks": { "title": "EvaluationLinks", "type": "object", "properties": { "files": { "format": "uri", "description": "The location to get all files of this entity. See operation \"Evaluations_ListFiles\" for more details.", "type": "string", "readOnly": true } }, "readOnly": true }, "EvaluationProperties": { "title": "EvaluationProperties", "type": "object", "properties": { "wordErrorRate1": { "format": "double", "description": "The word error rate of recognition with model1.", "type": "number", "readOnly": true }, "sentenceErrorRate1": { "format": "double", "description": "The sentence error rate of recognition with model1.", "type": "number", "readOnly": true }, "tokenErrorRate1": { "format": "double", "description": "The optional token error rate of recognition with model1.", "type": "number", "readOnly": true }, "sentenceCount1": { "format": "int32", "description": "The number of processed sentences by model1.", "type": "integer", "readOnly": true }, "wordCount1": { "format": "int32", "description": "The number of processed words by model1.", "type": "integer", "readOnly": true }, "correctWordCount1": { "format": "int32", "description": "The number of correctly recognized words by model1.", "type": "integer", "readOnly": true }, "wordSubstitutionCount1": { "format": "int32", "description": "The number of recognized words by model1, that are substitutions.", "type": "integer", "readOnly": true }, "wordDeletionCount1": { "format": "int32", "description": "The number of recognized words by model1, that are deletions.", "type": "integer", "readOnly": true }, "wordInsertionCount1": { "format": "int32", "description": "The number of recognized words by model1, that are insertions.", "type": "integer", "readOnly": true }, "tokenCount1": { "format": "int32", "description": "The optional number of processed tokens by model1.", "type": "integer", "readOnly": true }, "correctTokenCount1": { "format": "int32", "description": "The optional number of correctly recognized tokens by model1.", "type": "integer", "readOnly": true }, "tokenSubstitutionCount1": { "format": "int32", "description": "The optional number of recognized tokens by model1, that are substitutions.", "type": "integer", "readOnly": true }, "tokenDeletionCount1": { "format": "int32", "description": "The optional number of recognized tokens by model1, that are deletions.", "type": "integer", "readOnly": true }, "tokenInsertionCount1": { "format": "int32", "description": "The optional number of recognized tokens by model1, that are insertions.", "type": "integer", "readOnly": true }, "tokenErrors1": { "$ref": "#/definitions/TokenErrorDetails" }, "wordErrorRate2": { "format": "double", "description": "The word error rate of recognition with model2.", "type": "number", "readOnly": true }, "sentenceErrorRate2": { "format": "double", "description": "The sentence error rate of recognition with model2.", "type": "number", "readOnly": true }, "tokenErrorRate2": { "format": "double", "description": "The optional token error rate of recognition with model2.", "type": "number", "readOnly": true }, "sentenceCount2": { "format": "int32", "description": "The number of processed sentences by model2.", "type": "integer", "readOnly": true }, "wordCount2": { "format": "int32", "description": "The number of processed words by model2.", "type": "integer", "readOnly": true }, "correctWordCount2": { "format": "int32", "description": "The number of correctly recognized words by model2.", "type": "integer", "readOnly": true }, "wordSubstitutionCount2": { "format": "int32", "description": "The number of recognized words by model2, that are substitutions.", "type": "integer", "readOnly": true }, "wordDeletionCount2": { "format": "int32", "description": "The number of recognized words by model2, that are deletions.", "type": "integer", "readOnly": true }, "wordInsertionCount2": { "format": "int32", "description": "The number of recognized words by model2, that are insertions.", "type": "integer", "readOnly": true }, "tokenCount2": { "format": "int32", "description": "The optional number of processed tokens by model2.", "type": "integer", "readOnly": true }, "correctTokenCount2": { "format": "int32", "description": "The optional number of correctly recognized tokens by model2.", "type": "integer", "readOnly": true }, "tokenSubstitutionCount2": { "format": "int32", "description": "The optional number of recognized tokens by model2, that are substitutions.", "type": "integer", "readOnly": true }, "tokenDeletionCount2": { "format": "int32", "description": "The optional number of recognized tokens by model2, that are deletions.", "type": "integer", "readOnly": true }, "tokenInsertionCount2": { "format": "int32", "description": "The optional number of recognized tokens by model2, that are insertions.", "type": "integer", "readOnly": true }, "tokenErrors2": { "$ref": "#/definitions/TokenErrorDetails" }, "error": { "$ref": "#/definitions/EntityError" } }, "readOnly": true }, "EvaluationUpdate": { "title": "EvaluationUpdate", "type": "object", "properties": { "displayName": { "description": "The name of the object.", "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\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": { "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "name": { "description": "The name of this file.", "type": "string", "readOnly": true }, "kind": { "$ref": "#/definitions/FileKind" }, "links": { "$ref": "#/definitions/FileLinks" }, "properties": { "$ref": "#/definitions/FileProperties" }, "createdDateTime": { "format": "date-time", "description": "The creation time of this file.\nThe time stamp is encoded as ISO 8601 date and time format\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", "type": "string", "readOnly": true } } }, "FileKind": { "title": "FileKind", "description": "Type of data.", "enum": [ "DatasetReport", "Audio", "LanguageData", "PronunciationData", "AcousticDataArchive", "AcousticDataTranscriptionV2", "Transcription", "TranscriptionReport", "EvaluationDetails", "ModelReport", "OutputFormattingData" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "FileKind", "modelAsString": true, "values": [ { "value": "DatasetReport", "description": "Type of data is dataset report." }, { "value": "Audio", "description": "Type of data is audio." }, { "value": "LanguageData", "description": "Type of data is language data." }, { "value": "PronunciationData", "description": "Type of data is pronunciation data." }, { "value": "AcousticDataArchive", "description": "Type of data is acoustic data archive." }, { "value": "AcousticDataTranscriptionV2", "description": "Type of data is acoustic data transcription v2." }, { "value": "Transcription", "description": "Type of data is transcription." }, { "value": "TranscriptionReport", "description": "Type of data is transcription report." }, { "value": "EvaluationDetails", "description": "Type of data is evaluation details." }, { "value": "ModelReport", "description": "Type of data is model report." }, { "value": "OutputFormattingData", "description": "Type of data is output formatting input file." } ] } }, "FileLinks": { "title": "FileLinks", "type": "object", "properties": { "contentUrl": { "format": "uri", "description": "The url to retrieve the content of this file.", "type": "string", "readOnly": true } } }, "FileProperties": { "title": "FileProperties", "type": "object", "properties": { "size": { "format": "int64", "description": "The size of the data in bytes.", "type": "integer", "readOnly": true }, "durationMilliseconds": { "format": "int32", "description": "The total duration in milliseconds of the file in case this file is an audio file.", "default": 0, "type": "integer", "readOnly": true } } }, "InnerError": { "title": "InnerError", "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", "type": "object", "properties": { "message": { "description": "High level error message.", "type": "string" }, "target": { "description": "The source of the error.\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", "type": "string" }, "innerError": { "$ref": "#/definitions/InnerError" }, "code": { "$ref": "#/definitions/DetailedErrorCode" }, "details": { "description": "Additional supportive details regarding the error and/or expected policies.", "type": "object", "additionalProperties": { "type": "string" } } } }, "LanguageIdentificationMode": { "title": "LanguageIdentificationMode", "description": "The mode used for language identification.", "default": "Continuous", "enum": [ "Continuous", "Single" ], "type": "string", "x-ms-enum": { "name": "LanguageIdentificationMode", "modelAsString": true, "values": [ { "value": "Continuous", "description": "Continuous language identification (Default)." }, { "value": "Single", "description": "Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user." } ] } }, "LanguageIdentificationProperties": { "title": "LanguageIdentificationProperties", "required": [ "candidateLocales" ], "type": "object", "properties": { "candidateLocales": { "description": "The candidate locales for language identification (example [\"en-US\", \"de-DE\", \"es-ES\"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded.", "type": "array", "items": { "type": "string" } }, "speechModelMapping": { "description": "An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used.\nKeys must be locales contained in the candidate locales, values are entities for models of the respective locales.", "type": "object", "additionalProperties": { "$ref": "#/definitions/EntityReference" } }, "mode": { "$ref": "#/definitions/LanguageIdentificationMode" } } }, "ModelCopyAuthorization": { "title": "ModelCopyAuthorization", "required": [ "targetResourceRegion", "targetResourceId", "targetResourceEndpoint", "sourceResourceId", "expirationDateTime", "id" ], "type": "object", "properties": { "targetResourceRegion": { "description": "The region (aka location) of the target speech resource (e.g., westus2).", "minLength": 1, "type": "string" }, "targetResourceId": { "description": "The Azure Resource ID of the target speech resource.", "minLength": 1, "type": "string" }, "targetResourceEndpoint": { "description": "The endpoint (base url) of the target resource (with custom domain name when it is used).", "minLength": 1, "type": "string" }, "sourceResourceId": { "description": "The Azure Resource ID of the source speech resource.", "minLength": 1, "type": "string" }, "expirationDateTime": { "format": "date-time", "description": "The expiration date of this copy authorization.", "type": "string" }, "id": { "description": "The ID of this copy authorization.", "minLength": 1, "type": "string" } } }, "ModelCopyAuthorizationDefinition": { "title": "ModelCopyAuthorizationDefinition", "required": [ "sourceResourceId" ], "type": "object", "properties": { "sourceResourceId": { "description": "The Azure Resource ID of the source speech resource.", "minLength": 1, "type": "string" } } }, "ModelFile": { "title": "ModelFile", "type": "object", "properties": { "name": { "description": "The name of this file.", "type": "string", "readOnly": true }, "contentUrl": { "format": "uri", "description": "The url to retrieve the content of this file.", "type": "string", "readOnly": true } } }, "ModelManifest": { "title": "ModelManifest", "required": [ "model", "modelFiles", "properties" ], "type": "object", "properties": { "model": { "$ref": "#/definitions/EntityReference" }, "modelFiles": { "description": "The model files of this model.", "type": "array", "items": { "$ref": "#/definitions/ModelFile" } }, "properties": { "description": "The configuration for running this model in a container.", "type": "object", "additionalProperties": {} } } }, "ModelUpdate": { "title": "ModelUpdate", "type": "object", "properties": { "displayName": { "description": "The name of the object.", "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } } } }, "Operation": { "title": "Operation", "required": [ "id" ], "type": "object", "properties": { "id": { "format": "uuid", "description": "The identifier of this Operation.", "type": "string" }, "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "createdDateTime": { "format": "date-time", "description": "The time-stamp when the object was created.\nThe time stamp is encoded as ISO 8601 date and time format\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.\nThe time stamp is encoded as ISO 8601 date and time format\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" }, "result": { "$ref": "#/definitions/OperationResult" }, "error": { "$ref": "#/definitions/EntityError" } } }, "OperationResult": { "title": "OperationResult", "type": "object", "properties": { "link": { "format": "uri", "description": "The link to the result of the operation.", "type": "string", "readOnly": true } }, "readOnly": true }, "OutputFormatType": { "title": "OutputFormatType", "enum": [ "Lexical", "Display" ], "type": "string", "x-ms-enum": { "name": "OutputFormatType", "modelAsString": true, "values": [ { "value": "Lexical", "description": "Model provides the transcription output without formatting." }, { "value": "Display", "description": "Model supports display formatting transcriptions output or endpoints." } ] } }, "PaginatedBaseModels": { "title": "PaginatedBaseModels", "type": "object", "properties": { "values": { "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", "type": "array", "items": { "$ref": "#/definitions/BaseModel" }, "readOnly": true }, "@nextLink": { "format": "uri", "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", "type": "string", "readOnly": true } } }, "PaginatedCustomModels": { "title": "PaginatedCustomModels", "type": "object", "properties": { "values": { "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", "type": "array", "items": { "$ref": "#/definitions/CustomModel" }, "readOnly": true }, "@nextLink": { "format": "uri", "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", "type": "string", "readOnly": true } } }, "PaginatedDatasets": { "title": "PaginatedDatasets", "type": "object", "properties": { "values": { "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\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.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\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.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\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.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\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 } } }, "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.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\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.\n \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\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***" } ] } }, "PunctuationMode": { "title": "PunctuationMode", "description": "The mode used for punctuation.", "enum": [ "None", "Dictated", "Automatic", "DictatedAndAutomatic" ], "type": "string", "x-ms-enum": { "name": "PunctuationMode", "modelAsString": false, "values": [ { "value": "None", "description": "No punctuation." }, { "value": "Dictated", "description": "Dictated punctuation marks only, i.e., explicit punctuation." }, { "value": "Automatic", "description": "Automatic punctuation." }, { "value": "DictatedAndAutomatic", "description": "Dictated punctuation marks or automatic punctuation." } ] } }, "ResponseBlock": { "title": "ResponseBlock", "description": "ResponseBlock.", "type": "object", "properties": { "name": { "description": "The name of the block.", "type": "string" }, "size": { "format": "int32", "description": "The size of the block.", "type": "integer" } } }, "SharedModel": { "title": "SharedModel", "required": [ "displayName", "locale" ], "type": "object", "properties": { "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "displayName": { "description": "The display name of the object.", "minLength": 1, "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "locale": { "description": "The locale of the contained data.", "minLength": 1, "type": "string" }, "createdDateTime": { "format": "date-time", "description": "The time-stamp when the object was created.\nThe time stamp is encoded as ISO 8601 date and time format\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.\nThe time stamp is encoded as ISO 8601 date and time format\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" } } }, "SharedModelFeatures": { "title": "SharedModelFeatures", "description": "Features supported by the model.", "type": "object", "properties": { "supportsTranscriptionsSubmit": { "description": "A value indicating whether submission of transcription jobs is supported (POST /transcriptions:submit).", "type": "boolean", "readOnly": true }, "supportsTranscriptionsTranscribe": { "description": "A value indicating whether the transcribe action is supported (POST /transcriptions:transcribe).", "type": "boolean", "readOnly": true }, "supportsEndpoints": { "description": "A value indicating whether creation of endpoints for live transcription is supported.", "type": "boolean", "readOnly": true }, "supportsTranscriptionsOnSpeechContainers": { "description": "A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.", "type": "boolean", "readOnly": true }, "supportedOutputFormats": { "description": "Supported output formats.", "type": "array", "items": { "$ref": "#/definitions/OutputFormatType" }, "readOnly": true } } }, "Status": { "title": "Status", "description": "Describe the current state of the API.", "enum": [ "NotStarted", "Running", "Succeeded", "Failed" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "Status", "modelAsString": false, "values": [ { "value": "NotStarted", "description": "The long running operation has not yet started." }, { "value": "Running", "description": "The long running operation is currently processing." }, { "value": "Succeeded", "description": "The long running operation has successfully completed." }, { "value": "Failed", "description": "The long running operation has failed." } ] } }, "TextNormalizationKind": { "title": "TextNormalizationKind", "description": "The kind of text normalization.", "enum": [ "Default", "None" ], "type": "string", "x-ms-enum": { "name": "TextNormalizationKind", "modelAsString": true, "values": [ { "value": "Default", "description": "Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US)." }, { "value": "None", "description": "No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload." } ] } }, "TokenErrorDetails": { "title": "TokenErrorDetails", "type": "object", "properties": { "punctuation": { "$ref": "#/definitions/EditsSummary" }, "capitalization": { "$ref": "#/definitions/EditsSummary" }, "inverseTextNormalization": { "$ref": "#/definitions/EditsSummary" }, "lexical": { "$ref": "#/definitions/EditsSummary" }, "others": { "$ref": "#/definitions/EditsSummary" } }, "readOnly": true }, "Transcription": { "title": "Transcription", "required": [ "displayName", "locale", "properties" ], "type": "object", "properties": { "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "displayName": { "description": "The display name of the object.", "minLength": 1, "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\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. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected.", "minLength": 1, "type": "string" }, "createdDateTime": { "format": "date-time", "description": "The time-stamp when the object was created.\nThe time stamp is encoded as ISO 8601 date and time format\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.\nThe time stamp is encoded as ISO 8601 date and time format\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", "type": "string", "readOnly": true }, "contentUrls": { "description": "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\nThis property will not be returned in a response.", "type": "array", "items": { "format": "uri", "type": "string" } }, "model": { "$ref": "#/definitions/EntityReference" }, "links": { "$ref": "#/definitions/TranscriptionLinks" }, "properties": { "$ref": "#/definitions/TranscriptionProperties" }, "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.\nThe maximum size for a blob is 2.5GB.\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\nThis property will not be returned in a response.", "type": "string" }, "dataset": { "$ref": "#/definitions/EntityReference" }, "status": { "$ref": "#/definitions/Status" } } }, "TranscriptionLinks": { "title": "TranscriptionLinks", "type": "object", "properties": { "files": { "format": "uri", "description": "The location to get all files of this entity. See operation \"Transcriptions_ListFiles\" for more details.", "type": "string", "readOnly": true } }, "readOnly": true }, "TranscriptionLocales": { "title": "TranscriptionLocales", "type": "object", "properties": { "Transcribe": { "type": "array", "items": { "type": "string" } }, "Submit": { "type": "array", "items": { "type": "string" } } } }, "TranscriptionProperties": { "title": "TranscriptionProperties", "required": [ "timeToLiveHours" ], "type": "object", "properties": { "wordLevelTimestampsEnabled": { "description": "A value indicating whether word level timestamps are requested. The default value is\n`false`.", "type": "boolean" }, "displayFormWordLevelTimestampsEnabled": { "description": "A value indicating whether word level timestamps for the display form are requested. The default value is `false`.", "type": "boolean" }, "channels": { "description": "A collection of the requested channel numbers.\nIn the default case, the channels 0 and 1 are considered.", "type": "array", "items": { "format": "int32", "type": "integer" } }, "punctuationMode": { "$ref": "#/definitions/PunctuationMode" }, "profanityFilterMode": { "$ref": "#/definitions/ProfanityFilterMode" }, "destinationContainerUrl": { "format": "uri", "description": "The requested destination container.\n### Remarks ###\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\ntranscription will be deleted normally, but the data stored in the destination container, including\ntranscription results, will remain untouched, because no delete permissions are required for this\ncontainer.\n\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\ninstead of `destinationContainerUrl`, where blobs can be cleaned up.", "type": "string" }, "timeToLiveHours": { "format": "int32", "description": "How long the transcription will be kept in the system after it has completed. Once the\ntranscription reaches the time to live after completion(successful or failed) it will be automatically\ndeleted.\n\nNote: When using BYOS (bring your own storage), the result files on the customer owned storage account\nwill also be deleted.Use either destinationContainerUrl to specify a separate container for result files\nwhich will not be deleted when the timeToLive expires, or retrieve the result files through the API and\nstore them as needed.\n\nThe shortest supported duration is 6 hours, the longest supported duration is 31 days. 2 days (48 hours) is the recommended default value\nwhen data is consumed directly.", "type": "integer" }, "languageIdentification": { "$ref": "#/definitions/LanguageIdentificationProperties" }, "diarization": { "$ref": "#/definitions/DiarizationProperties" }, "error": { "$ref": "#/definitions/EntityError" }, "durationMilliseconds": { "format": "int64", "description": "The duration in milliseconds of the transcription.\nDurations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers.", "default": 0, "type": "integer", "readOnly": true } } }, "TranscriptionUpdate": { "title": "TranscriptionUpdate", "type": "object", "properties": { "displayName": { "description": "The name of the object.", "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } } } }, "UploadedBlocks": { "title": "UploadedBlocks", "description": "List of uploaded blocks.", "type": "object", "properties": { "committedBlocks": { "description": "The block description of blocks already committed.", "type": "array", "items": { "$ref": "#/definitions/ResponseBlock" } }, "uncommittedBlocks": { "description": "The block description of blocks not committed to the blob.", "type": "array", "items": { "$ref": "#/definitions/ResponseBlock" } } } }, "WebHook": { "title": "WebHook", "required": [ "displayName", "webUrl", "events" ], "type": "object", "properties": { "self": { "format": "uri", "description": "The location of this entity.", "type": "string", "readOnly": true }, "displayName": { "description": "The display name of the object.", "minLength": 1, "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/WebHookProperties" }, "webUrl": { "format": "uri", "description": "The registered URL that will be used to send the POST requests for the registered events to.", "type": "string" }, "events": { "$ref": "#/definitions/WebHookEvents" }, "createdDateTime": { "format": "date-time", "description": "The time-stamp when the object was created.\nThe time stamp is encoded as ISO 8601 date and time format\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.\nThe time stamp is encoded as ISO 8601 date and time format\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" }, "links": { "$ref": "#/definitions/WebHookLinks" } } }, "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": { "test": { "format": "uri", "description": "The URL that can be used sending test events to the registered URL of a web hook registration. See operation \"WebHooks_Test\" for more details.", "type": "string", "readOnly": true }, "ping": { "format": "uri", "description": "The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation \"WebHooks_Ping\" for more details.", "type": "string", "readOnly": true } }, "readOnly": true }, "WebHookProperties": { "title": "WebHookProperties", "type": "object", "properties": { "apiVersion": { "description": "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\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.\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", "type": "string" }, "error": { "$ref": "#/definitions/EntityError" } } }, "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.\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": { "displayName": { "description": "The name of the object.", "type": "string" }, "description": { "description": "The description of the object.", "type": "string" }, "webUrl": { "format": "uri", "description": "The registered URL that will be used to send the POST requests for the registered events to.", "type": "string" }, "customProperties": { "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\nallowed value length is 256 characters and the count of allowed entries is 10.", "type": "object", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/WebHookPropertiesUpdate" }, "events": { "$ref": "#/definitions/WebHookEvents" } } }, "ChannelCombinedPhrases": { "description": "The full transcript per channel.", "required": [ "text" ], "type": "object", "properties": { "channel": { "format": "int32", "description": "The 0-based channel index. Only present if channel separation is enabled.", "type": "integer" }, "text": { "description": "The transcribed text.", "type": "string" } } }, "Phrase": { "description": "A transcribed phrase.", "required": [ "confidence", "durationMilliseconds", "offsetMilliseconds", "text" ], "type": "object", "properties": { "channel": { "format": "int32", "description": "The 0-based channel index. Only present if channel separation is enabled.", "type": "integer" }, "speaker": { "format": "int32", "description": "A unique integer number that is assigned to each speaker detected in the audio without particular order. Only present if speaker diarization is enabled.", "type": "integer" }, "offsetMilliseconds": { "format": "int32", "description": "The start offset of the phrase in milliseconds.", "type": "integer" }, "durationMilliseconds": { "format": "int32", "description": "The duration of the phrase in milliseconds.", "type": "integer" }, "text": { "description": "The transcribed text of the phrase.", "type": "string" }, "words": { "description": "The words that make up the phrase. Only present if word-level timestamps are enabled.", "type": "array", "items": { "$ref": "#/definitions/Word" } }, "locale": { "description": "The locale of the phrase.", "type": "string" }, "confidence": { "format": "float", "description": "The confidence value for the phrase.", "type": "number" } } }, "TranscribeDefinition": { "description": "Metadata for a transcription request.", "type": "object", "properties": { "locales": { "description": "A list of possible locales for the transcription. If not specified, the locale of the speech in the audio is detected automatically from all supported locales.", "type": "array", "items": { "type": "string" } }, "models": { "description": "Maps some or all candidate locales to a model URI to be used for transcription. If no mapping is given, the default model for the locale is used.", "type": "object", "additionalProperties": { "format": "uri", "type": "string" } }, "profanityFilterMode": { "$ref": "#/definitions/ProfanityFilterMode" }, "diarization": { "$ref": "#/definitions/TranscribeDiarizationProperties" }, "channels": { "description": "The 0-based indices of the channels to be transcribed separately. If not specified, multiple channels are merged and transcribed jointly. Only up to two channels are supported.", "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "TranscribeDiarizationProperties": { "description": "The diarization settings. Diarization settings must be specified to enable diarization.", "type": "object", "properties": { "enabled": { "description": "Gets or sets a value indicating whether speaker diarization is enabled.", "type": "boolean" }, "maxSpeakers": { "format": "int32", "description": "Gets or sets a hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36.", "maximum": 35, "minimum": 2, "type": "integer" } } }, "TranscribeResult": { "description": "The result of the transcribe operation.", "required": [ "combinedPhrases", "durationMilliseconds", "phrases" ], "type": "object", "properties": { "durationMilliseconds": { "format": "int32", "description": "The duration of the audio in milliseconds.", "type": "integer" }, "combinedPhrases": { "description": "The full transcript for each channel.", "type": "array", "items": { "$ref": "#/definitions/ChannelCombinedPhrases" } }, "phrases": { "description": "The transcription results segmented into phrases.", "type": "array", "items": { "$ref": "#/definitions/Phrase" } } } }, "Word": { "description": "Time-stamped word in the display form.", "required": [ "durationMilliseconds", "offsetMilliseconds", "text" ], "type": "object", "properties": { "text": { "description": "The recognized word, including punctuation.", "type": "string" }, "offsetMilliseconds": { "format": "int32", "description": "The start offset of the word in milliseconds.", "type": "integer" }, "durationMilliseconds": { "format": "int32", "description": "The duration of the word in milliseconds.", "type": "integer" } } } }, "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" }, "apiVersionQueryParameter": { "in": "query", "name": "api-version", "description": "The requested api version.", "required": true, "type": "string", "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" }, "sasLifetimeQueryParameter": { "in": "query", "name": "sasLifetimeMinutes", "description": "This parameter defines the duration in minutes for which an SAS url should be valid.\r\n The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources\r\n that don't have BYOS enabled, the default SAS validity duration is 12 hours.\r\n For speech resources with BYOS, returned urls do not contain an SAS token.", "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." } }, "security": [ { "api_key": [] } ], "schemes": [ "https" ], "x-ms-parameterized-host": { "hostTemplate": "{endpoint}/speechtotext", "useSchemePrefix": false, "parameters": [ { "$ref": "#/parameters/endpoint" } ] } }