Microsoft Azure Speech Services API V31preview1 is a cutting-edge application programming interface that is designed to provide advanced speech recognition and speech-to-text conversion capabilities for developers. This powerful API allows users to easily integrate speech recognition functionality into their applications, allowing for seamless voice-controlled interactions.
swagger: '2.0'
info:
title: Microsoft Azure Speech Services API v3.1-preview.1
description: Speech Services API v3.1-preview.1.
contact:
name: Cognitive Services - Speech Services
url: https://docs.microsoft.com/azure/cognitive-services/speech-service/support
version: v3.1-preview.1
paths:
/datasets/locales:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Gets A List Of Supported Locales For Datasets'
operationId: microsoftAzureDatasetsListsupportedlocales
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DatasetLocales'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get the supported locales:
$ref: ./examples/get_supported_dataset_locales.json
description: Needs a more full description created.
/datasets:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Gets A List Of Datasets For The Authenticated Subscription'
operationId: microsoftAzureDatasetsList
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 <ul><li><b>Supported properties:</b> displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n </li><li><b>Operators:</b>\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 </li><li><b>Example:</b>```filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'```</li></ul>"
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedDatasets'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all datasets:
$ref: ./examples/get_datasets.json
Get all acoustic datasets:
$ref: ./examples/get_acoustic_datasets.json
description: Needs a more full description created.
post:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: >-
Microsoft Azure Uploads And Creates A New Dataset By Getting The Data From A Specified Url Or Starts Waiting For Data Blocks To Be Uploaded
operationId: microsoftAzureDatasetsCreate
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: dataset
description: Definition for the new dataset.
required: true
schema:
$ref: '#/definitions/Dataset'
responses:
'201':
description: >-
The response contains information about the entity as payload and
its location as header.
schema:
$ref: '#/definitions/Dataset'
headers:
Location:
description: The location of the created resource.
type: string
format: uri
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Create a dataset with content url:
$ref: ./examples/create_dataset_with_content_url.json
Create dataset from data blocks:
$ref: ./examples/create_dataset_with_blocks.json
description: Needs a more full description created.
/datasets/{id}:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Gets The Dataset Identified By The Given Id'
operationId: microsoftAzureDatasetsGet
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Dataset'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get a dataset:
$ref: ./examples/get_dataset.json
description: Needs a more full description created.
patch:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Updates The Mutable Details Of The Dataset Identified By Its Id'
operationId: microsoftAzureDatasetsUpdate
consumes:
- application/json
- application/merge-patch+json
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
- in: body
name: datasetUpdate
description: The updated values for the dataset.
required: true
schema:
$ref: '#/definitions/DatasetUpdate'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Dataset'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Update a dataset:
$ref: ./examples/update_dataset.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Deletes The Specified Dataset'
operationId: microsoftAzureDatasetsDelete
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
responses:
'204':
description: The dataset was successfully deleted or did not exist.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete a dataset:
$ref: ./examples/delete_dataset.json
description: Needs a more full description created.
/datasets/{id}/blocks:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Gets The List Of Uploaded Blocks For This Dataset'
operationId: microsoftAzureDatasetsGetdatasetblocks
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
responses:
'200':
description: OK
schema:
$ref: '#/definitions/UploadedBlocks'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get uploaded blocks for dataset:
$ref: ./examples/get_dataset_blocks.json
description: Needs a more full description created.
put:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: >-
Microsoft Azure Upload A Block Of Data For The Dataset The Maximum Size Of The Block Is 8mib
operationId: microsoftAzureDatasetsUploadblock
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
- 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
description: Needs a more full description created.
/datasets/upload:
post:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Uploads Data And Creates A New Dataset'
operationId: microsoftAzureDatasetsUpload
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- in: formData
name: project
description: >-
The optional string representation of the url of a project. If set,
the dataset will be associated with that project.
type: string
- in: formData
name: displayName
description: The name of this dataset (required).
required: true
type: string
- in: formData
name: description
description: Optional description of this dataset.
type: string
- in: formData
name: locale
description: The locale of this dataset (required).
required: true
type: string
- in: formData
name: kind
description: >-
The kind of the dataset (required). Possible values are "Language",
"Acoustic", "Pronunciation", "AudioFiles", "LanguageMarkdown".
required: true
type: string
- in: formData
name: customProperties
description: >-
The optional custom properties of this entity. The maximum allowed
key length is 64 characters, the maximum allowed value length is 256
characters and the count of allowed entries is 10.
type: string
- in: formData
name: data
description: >-
For acoustic datasets, a zip file containing the audio data and a
text file containing the transcriptions for the audio data. For
language datasets, a text file containing the language or
pronunciation data. Required in both cases.
type: file
- in: formData
name: email
description: >-
An optional string containing the email address to send email
notifications to in case the operation completes. The value will be
removed after successfully sending the email.
type: string
responses:
'201':
description: >-
The response contains information about the entity as payload and
its location as header.
schema:
$ref: '#/definitions/Dataset'
headers:
Location:
description: The location of the created resource.
type: string
format: uri
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
deprecated: true
x-ms-examples:
Upload a dataset:
$ref: ./examples/upload_dataset.json
description: Needs a more full description created.
/datasets/{id}/blocks:commit:
post:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Commit Block List To Complete The Upload Of The Dataset'
operationId: microsoftAzureDatasetsCommitblocks
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
- in: body
name: 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
description: Needs a more full description created.
/datasets/{id}/files:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Gets The Files Of The Dataset Identified By The Given Id'
operationId: microsoftAzureDatasetsListfiles
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
- $ref: '#/parameters/skipQueryParameter'
- $ref: '#/parameters/topQueryParameter'
- in: query
name: filter
description: "A filtering expression for selecting a subset of the available files.\r\n <ul><li><b>Supported properties:</b> name, createdDateTime, kind.</li><li><b>Operators:</b>\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 </li><li><b>Example:</b>```filter=name eq 'myaudio.wav' and kind eq 'Audio'```</li></ul>"
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedFiles'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all files:
$ref: ./examples/get_dataset_files.json
Get all dataset report files:
$ref: ./examples/get_dataset_report_files.json
description: Needs a more full description created.
/datasets/{id}/files/{fileId}:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: >-
Microsoft Azure Gets One Specific File Identified With Fileid From A Dataset Identified With Id
operationId: microsoftAzureDatasetsGetfile
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
- in: path
name: fileId
description: The identifier of the file.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/File'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get a file:
$ref: ./examples/get_dataset_file.json
description: Needs a more full description created.
/endpoints/locales:
get:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Gets A List Of Supported Locales For Endpoint Creations'
operationId: microsoftAzureEndpointsListsupportedlocales
produces:
- application/json
responses:
'200':
description: OK
schema:
type: array
items:
type: string
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get the supported locales:
$ref: ./examples/get_supported_endpoint_locales.json
description: Needs a more full description created.
/endpoints:
get:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Gets The List Of Endpoints For The Authenticated Subscription'
operationId: microsoftAzureEndpointsList
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 <ul><li><b>Supported properties:</b> displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n </li><li><b>Operators:</b>\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 </li><li><b>Example:</b>```filter=locale eq 'en-US'```</li></ul>"
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedEndpoints'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all endpoints:
$ref: ./examples/get_endpoints.json
Get all queued endpoints.:
$ref: ./examples/get_not_started_endpoints.json
description: Needs a more full description created.
post:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Creates A New Endpoint'
operationId: microsoftAzureEndpointsCreate
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: endpoint
description: The details of the endpoint.
required: true
schema:
$ref: '#/definitions/Endpoint'
responses:
'201':
description: >-
The response contains information about the entity as payload and
its location as header.
schema:
$ref: '#/definitions/Endpoint'
headers:
Location:
description: The location of the created resource.
type: string
format: uri
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Create an endpoint:
$ref: ./examples/create_endpoint.json
description: Needs a more full description created.
/endpoints/{id}:
get:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Gets The Endpoint Identified By The Given Id'
operationId: microsoftAzureEndpointsGet
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Endpoint'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get an endpoint:
$ref: ./examples/get_endpoint.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Deletes The Endpoint Identified By The Given Id'
operationId: microsoftAzureEndpointsDelete
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
responses:
'204':
description: The model endpoint was successfully deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete an endpoint:
$ref: ./examples/delete_endpoint.json
description: Needs a more full description created.
patch:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Updates The Metadata Of The Endpoint Identified By The Given Id'
operationId: microsoftAzureEndpointsUpdate
consumes:
- application/json
- application/merge-patch+json
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- in: body
name: endpointUpdate
description: The updated values for the endpoint.
required: true
schema:
$ref: '#/definitions/EndpointUpdate'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Endpoint'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Update an endpoint:
$ref: ./examples/update_endpoint.json
description: Needs a more full description created.
/endpoints/{id}/files/logs:
get:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored For A Given Endpoint
operationId: microsoftAzureEndpointsListlogs
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
- in: query
name: skipToken
description: >-
Token to skip logs that were already retrieved in previous requests.
Pagination starts from beginning when not defined.
type: string
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedFiles'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all endpoint logs:
$ref: ./examples/get_endpoint_logs.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Deletes The Specified Audio And Transcription Logs That Have Been Stored For A Given Endpoint It Deletes All Logs Before And Including A Specific Day
description: >-
The deletion process is done asynchronously and can take up to one day
depending on the amount of log files.
operationId: microsoftAzureEndpointsDeletelogs
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- in: query
name: endDate
description: "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified."
type: string
responses:
'202':
description: The logs will be deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete all endpoint logs:
$ref: ./examples/delete_endpoint_logs.json
/endpoints/{id}/files/logs/{logId}:
get:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Gets A Specific Audio Or Transcription Log For A Given Endpoint'
operationId: microsoftAzureEndpointsGetlog
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- in: path
name: logId
description: The identifier of the log.
required: true
type: string
- $ref: '#/parameters/sasValidityQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/File'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get an endpoint log:
$ref: ./examples/get_endpoint_log.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Deletes One Audio Or Transcription Log That Have Been Stored For A Given Endpoint
operationId: microsoftAzureEndpointsDeletelog
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- in: path
name: logId
description: The identifier of the log.
required: true
type: string
responses:
'204':
description: The log was successfully deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete an endpoint log:
$ref: ./examples/delete_endpoint_log.json
description: Needs a more full description created.
/endpoints/base/{locale}/files/logs:
get:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored When Using The Default Base Model Of A Given Language
operationId: microsoftAzureEndpointsListbasemodellogs
produces:
- application/json
parameters:
- in: path
name: locale
description: The language used to select the default base model.
required: true
type: string
- $ref: '#/parameters/sasValidityQueryParameter'
- in: query
name: skipToken
description: >-
Token to skip logs that were already retrieved in previous requests.
Pagination starts from beginning when not defined.
type: string
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedFiles'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all base model logs:
$ref: ./examples/get_base_model_logs.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Deletes The Specified Audio And Transcription Logs That Have Been Stored When Using The Default Base Model Of A Given Language It Deletes All Logs Before And Including A Specific Day
description: >-
Deletion process is done asynchronously and can take up to one day
depending on the amount of log files.
operationId: microsoftAzureEndpointsDeletebasemodellogs
produces:
- application/json
parameters:
- in: path
name: locale
description: The language used to select the default base model.
required: true
type: string
- in: query
name: endDate
description: "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified."
type: string
responses:
'202':
description: The logs will be deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete all base model logs:
$ref: ./examples/delete_base_model_logs.json
/endpoints/base/{locale}/files/logs/{logId}:
get:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Gets A Specific Audio Or Transcription Log For The Default Base Model In A Given Language
operationId: microsoftAzureEndpointsGetbasemodellog
produces:
- application/json
parameters:
- in: path
name: locale
description: The language used to select the default base model.
required: true
type: string
- in: path
name: logId
description: The identifier of the log.
required: true
type: string
- $ref: '#/parameters/sasValidityQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/File'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get a base model log:
$ref: ./examples/get_base_model_log.json
description: Needs a more full description created.
# --- truncated at 32 KB (166 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/speech-services-api-v31-preview1-openapi-original.yml