|
| 1 | +--- |
| 2 | +title: Migrate code from v3.2 to version 2024-11-15 - Speech service |
| 3 | +titleSuffix: Azure AI services |
| 4 | +description: This document helps developers migrate code from v3.2 to version 2024-11-15 of the Speech to text REST API. |
| 5 | +author: eric-urban |
| 6 | +ms.author: eur |
| 7 | +manager: nitinme |
| 8 | +ms.service: azure-ai-speech |
| 9 | +ms.topic: how-to |
| 10 | +ms.date: 11/12/2024 |
| 11 | +#Customer intent: As a developer, I want to migrate code from v3.2 to version 2024-11-15 of the Speech to text REST API. |
| 12 | +--- |
| 13 | + |
| 14 | +# Migrate code from v3.2 to version 2024-11-15 |
| 15 | + |
| 16 | +The Speech to text REST API is used for [fast transcription](./fast-transcription-create.md), [batch transcription](batch-transcription.md), and [custom speech](custom-speech-overview.md). This article describes changes from version 3.2 to version 2024-11-15. |
| 17 | + |
| 18 | +> [!IMPORTANT] |
| 19 | +> Speech to text REST API version `2024-11-15` is the latest version that's generally available. |
| 20 | +> - [Speech to text REST API](rest-speech-to-text.md) version `2024-05-15-preview` will be retired on a date to be announced. |
| 21 | +> - Speech to text REST API `v3.0`, `v3.1`, `v3.2`, `3.2-preview.1`, and `3.2-preview.2` will be retired on April 1st, 2026. |
| 22 | +> |
| 23 | +> For more information about upgrading, see the Speech to text REST API [v3.0 to v3.1](migrate-v3-0-to-v3-1.md), [v3.1 to v3.2](migrate-v3-1-to-v3-2.md), and [v3.2 to 2024-11-15](migrate-2024-11-15.md) migration guides. |
| 24 | +
|
| 25 | +## Base path |
| 26 | + |
| 27 | +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. |
| 28 | + |
| 29 | +## Datasets |
| 30 | + |
| 31 | +The `email` property and the connected email notification process is removed from the API. |
| 32 | + |
| 33 | +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. |
| 34 | + |
| 35 | +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. |
| 36 | + |
| 37 | +The `project` property is removed in creation requests. |
| 38 | + |
| 39 | +## Models |
| 40 | + |
| 41 | +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. |
| 42 | + |
| 43 | +The `email` property and the connected email notification process is removed from the API. |
| 44 | + |
| 45 | +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. |
| 46 | + |
| 47 | +The `GET models/id/manifest` operation now always requires a nonzero SAS lifetime. The corresponding `sasValidityInSeconds` property is renamed to `sasLifetimeMinutes`. |
| 48 | + |
| 49 | +The `project` property is removed in creation requests. |
| 50 | + |
| 51 | +## Evaluations |
| 52 | + |
| 53 | +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. |
| 54 | + |
| 55 | +The `project` property is removed in creation requests |
| 56 | + |
| 57 | +The `email` property and the connected email notification process is removed from the API. |
| 58 | + |
| 59 | +## Endpoints |
| 60 | + |
| 61 | +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. |
| 62 | + |
| 63 | +Removed support for `timeToLive` in endpoint creations. |
| 64 | + |
| 65 | +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. |
| 66 | + |
| 67 | +Endpoint links now only return endpoint of websocket connection, used for SDK. |
| 68 | + |
| 69 | +The `project` property is removed in creation requests. |
| 70 | + |
| 71 | +The `email` property and the connected email notification process is removed from the API. |
| 72 | + |
| 73 | +## Transcriptions |
| 74 | + |
| 75 | +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. |
| 76 | + |
| 77 | +Transcription creation: `timeToLive` renamed to `timeToLiveHours` including a format change from ISO8601 formatted string to a simple int (number of hours). |
| 78 | + |
| 79 | +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. |
| 80 | + |
| 81 | +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. |
| 82 | + |
| 83 | +The `project` property is removed in creation requests. |
| 84 | + |
| 85 | +The `email` property and the connected email notification process is removed from the API. |
| 86 | + |
| 87 | +## Projects |
| 88 | + |
| 89 | +The projects API is removed. |
| 90 | + |
| 91 | +## Next steps |
| 92 | + |
| 93 | +* [Speech to text REST API](rest-speech-to-text.md) |
| 94 | +* [Speech to text REST API 2024-11-15 reference documentation](/rest/api/speechtotext/operation-groups?view=rest-speechtotext-2024-11-15&preserve-view=true) |
0 commit comments