Migrate code from v3.2 to version 2024-11-15

The Speech to text REST API is used for fast transcription, batch transcription, and custom speech. This article describes changes from version 3.2 to version 2024-11-15.

Base path

Custom speech API switched from a path based versioning scheme to a query parameter based scheme in alignment with general Azure API versioning schemes. This required changes to the used base path. Update path from /speechtotext/v3.2 to /speechtotext and append API version with ?api-version=2024-11-15 to all requests.

Datasets

The email property and the connected email notification process is removed from the API.

The duration property in dataset responses is renamed from duration to durationMilliseconds and are now a plain number instead of an ISO8601 formatted string (P1D2H3M4S…) to further simply processing.

The query parameter sasValidityInSeconds is renamed to sasLifetimeMinutes for getting files. Usage is only allowed for an account with BYOS disabled. For BYOS enabled accounts, SAS URLs aren't returned.

The project property is removed in creation requests.

Models

Removed the text property in a model creation request. The alternative is to create a dataset with the text content and create a dataset first, which then is later on used for model creation.

The email property and the connected email notification process is removed from the API.

The query parameter sasValidityInSeconds is renamed to sasLifetimeMinutes for getting files. Usage is only allowed for an account with BYOS (bring your own storage) disabled. For BYOS enabled accounts, SAS URLs aren't returned.

The GET models/id/manifest operation now always requires a nonzero SAS lifetime. The corresponding sasValidityInSeconds property is renamed to sasLifetimeMinutes.

The project property is removed in creation requests.

Evaluations

The query parameter sasValidityInSeconds is renamed to sasLifetimeMinutes for getting files. Usage is only allowed for an account with BYOS disabled. For BYOS enabled accounts, SAS URLs aren't returned.

The project property is removed in creation requests

The email property and the connected email notification process is removed from the API.

Endpoints

The API to retrieve and delete log files of endpoint logs is removed. Custom speech now supports BYOS (bring your own storage). Only accounts with BYOS enabled can enable logging on model endpoints. This offers full manageability of log files on customer storage instead of a proxy API.

Removed support for timeToLive in endpoint creations.

Removed the text property in an endpoint creation request. The alternative is to create a dataset with the text content and create a dataset first, which then is later on used for model creation. This model can then be used to create an endpoint.

Endpoint links now only return endpoint of websocket connection, used for SDK.

The project property is removed in creation requests.

The email property and the connected email notification process is removed from the API.

Transcriptions

Removed the top-level diarizationEnabled property of a transcription. The diarization configuration is simplified to "diarization": {"maxSpeakers": 2,"enabled": true}. The maxSpeakers property is optional and defaults to 2. The enabled property is required for diarization.

Transcription creation: timeToLive renamed to timeToLiveHours including a format change from ISO8601 formatted string to a simple int (number of hours).

The duration property in transcription responses is renamed from duration to durationMilliseconds and are now a plain number instead of an ISO8601 formatted string (P1D2H3M4S…) to further simplify processing. Transcription result files have this property added for consistency with API.

The query parameter sasValidityInSeconds is renamed to sasLifetimeMinutes for getting files. Usage is only allowed for an account with BYOS disabled. For BYOS enabled accounts, SAS URLs aren't returned.

The project property is removed in creation requests.

The email property and the connected email notification process is removed from the API.

Projects

The projects API is removed.

Next steps

• Speech to text REST API
• Speech to text REST API 2024-11-15 reference documentation