Share via

Datasets - Commit Blocks

Service:
Azure AI Services
API Version:
2025-10-15

Commit block list to complete the upload of the dataset.

POST {endpoint}/speechtotext/datasets/{id}/blocks:commit?api-version=2025-10-15

URI Parameters

Name In Required Type Description
endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
id
 path True

string (uuid)

The identifier of the dataset.
api-version
 query True

string

The requested api version.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Provide your cognitive services account key here.

Request Body

Name Type Description
blockList

CommitBlocksEntry[]

The list of blocks that compile the dataset.

Responses

Name Type Description
200 OK

The block list is accepted and the data import process can continue.
Other Status Codes

Error

An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Examples

Commit uploaded blocks to dataset

Sample request

POST {endpoint}/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks:commit?api-version=2025-10-15


[
  {
    "kind": "Uncommitted",
    "id": "AAA="
  },
  {
    "kind": "Uncommitted",
    "id": "AAE="
  },
  {
    "kind": "Uncommitted",
    "id": "AAI="
  }
]

Sample response

Status code:
200

Definitions

Name Description
BlockKind

BlockKind
CommitBlocksEntry

CommitBlocksEntry
DetailedErrorCode

DetailedErrorCode
Error

Error
ErrorCode

ErrorCode
InnerError

InnerError

BlockKind

Enumeration

BlockKind

Value Description
Committed

A data block from the committed block list.
Uncommitted

A data block from the uncommitted block list.
Latest

A data block from the uncommitted block list, if present, otherwise from the committed block list.

CommitBlocksEntry

Object

CommitBlocksEntry

Name Type Description
id

string

kind

BlockKind

BlockKind
Type of data block.

DetailedErrorCode

Enumeration

DetailedErrorCode

Value Description
InvalidParameterValue

Invalid parameter value.
InvalidRequestBodyFormat

Invalid request body format.
EmptyRequest

Empty Request.
MissingInputRecords

Missing Input Records.
InvalidDocument

Invalid Document.
ModelVersionIncorrect

Model Version Incorrect.
InvalidDocumentBatch

Invalid Document Batch.
UnsupportedLanguageCode

Unsupported language code.
DataImportFailed

Data import failed.
InUseViolation

In use violation.
InvalidLocale

Invalid locale.
InvalidBaseModel

Invalid base model.
InvalidAdaptationMapping

Invalid adaptation mapping.
InvalidDataset

Invalid dataset.
InvalidTest

Invalid test.
FailedDataset

Failed dataset.
InvalidModel

Invalid model.
InvalidTranscription

Invalid transcription.
InvalidPayload

Invalid payload.
InvalidParameter

Invalid parameter.
EndpointWithoutLogging

Endpoint without logging.
InvalidPermissions

Invalid permissions.
InvalidPrerequisite

Invalid prerequisite.
InvalidProductId

Invalid product id.
InvalidSubscription

Invalid subscription.
InvalidProject

Invalid project.
InvalidProjectKind

Invalid project kind.
InvalidRecordingsUri

Invalid recordings uri.
OnlyOneOfUrlsOrContainerOrDataset

Only one of urls or container or dataset.
ExceededNumberOfRecordingsUris

Exceeded number of recordings uris.
InvalidChannels

Invalid channels.
ModelMismatch

Model mismatch.
ProjectGenderMismatch

Project gender mismatch.
ModelDeprecated

Model deprecated.
ModelExists

Model exists.
ModelNotDeployable

Model not deployable.
EndpointNotUpdatable

Endpoint not updatable.
SingleDefaultEndpoint

Single default endpoint.
EndpointCannotBeDefault

Endpoint cannot be default.
InvalidModelUri

Invalid model uri.
SubscriptionNotFound

Subscription not found.
QuotaViolation

Quota violation.
UnsupportedDelta

Unsupported delta.
UnsupportedFilter

Unsupported filter.
UnsupportedPagination

Unsupported pagination.
UnsupportedDynamicConfiguration

Unsupported dynamic configuration.
UnsupportedOrderBy

Unsupported order by.
NoUtf8WithBom

No utf8 with bom.
ModelDeploymentNotCompleteState

Model deployment not complete state.
SkuLimitsExist

Sku limits exist.
DeployingFailedModel

Deploying failed model.
UnsupportedTimeRange

Unsupported time range.
InvalidLogDate

Invalid log date.
InvalidLogId

Invalid log id.
InvalidLogStartTime

Invalid log start time.
InvalidLogEndTime

Invalid log end time.
InvalidTopForLogs

Invalid top for logs.
InvalidSkipTokenForLogs

Invalid skip token for logs.
DeleteNotAllowed

Delete not allowed.
Forbidden

Forbidden.
DeployNotAllowed

Deploy not allowed.
UnexpectedError

Unexpected error.
InvalidCollection

Invalid collection.
InvalidCallbackUri

Invalid callback uri.
InvalidSasValidityDuration

Invalid sas validity duration.
InaccessibleCustomerStorage

Inaccessible customer storage.
UnsupportedClassBasedAdaptation

Unsupported class based adaptation.
InvalidWebHookEventKind

Invalid web hook event kind.
InvalidTimeToLive

Invalid time to live.
InvalidSourceAzureResourceId

Invalid source Azure resource ID.
ModelCopyAuthorizationExpired

Expired ModelCopyAuthorization.
EndpointLoggingNotSupported

Endpoint logging not supported.
NoLanguageIdentified

Language Identification did not recognize any language.
MultipleLanguagesIdentified

Language Identification recognized multiple languages. No dominant language could be determined.
InvalidAudioFormat

The format of input audio is not supported.
BadChannelConfiguration

There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application.
InvalidChannelSpecification

The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.)
AudioLengthLimitExceeded

The audio file is longer than the maximum allowed duration.
EmptyAudioFile

The audio file is empty.

Error

Object

Error

Name Type Description
code

ErrorCode

ErrorCode
High level error codes.
details

Error[]

Additional supportive details regarding the error and/or expected policies.
innerError

InnerError

InnerError
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. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message

string

High level error message.
target

string

The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ErrorCode

Enumeration

ErrorCode

Value Description
InvalidRequest

Representing the invalid request error code.
InvalidArgument

Representing the invalid argument error code.
InternalServerError

Representing the internal server error error code.
ServiceUnavailable

Representing the service unavailable error code.
NotFound

Representing the not found error code.
PipelineError

Representing the pipeline error error code.
Conflict

Representing the conflict error code.
InternalCommunicationFailed

Representing the internal communication failed error code.
Forbidden

Representing the forbidden error code.
NotAllowed

Representing the not allowed error code.
Unauthorized

Representing the unauthorized error code.
UnsupportedMediaType

Representing the unsupported media type error code.
TooManyRequests

Representing the too many requests error code.
UnprocessableEntity

Representing the unprocessable entity error code.

InnerError

Object

InnerError

Name Type Description
code

DetailedErrorCode

DetailedErrorCode
Detailed error code enum.
details

object

Additional supportive details regarding the error and/or expected policies.
innerError

InnerError

InnerError
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. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message

string

High level error message.
target

string

The source of the error. For example it would be "documents" or "document id" in case of invalid document.