Skip to content

Commit aff113e

Browse files
committed
update
1 parent a8f3746 commit aff113e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

articles/ai-services/openai/api-version-lifecycle.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@ This article is to help you understand the support lifecycle for Azure OpenAI AP
1919
> [!NOTE]
2020
> New API response objects may be added to the API response without version changes. We recommend you only parse the response objects you require.
2121
>
22-
> The `2025-04-01-preview` Azure OpenAI spec uses OpenAPI 3.1. It is a known issue that this is currently not fully supported by [Azure API Management](/azure/api-management/api-management-key-concepts)
22+
> The `2025-04-01-preview` Azure OpenAI spec uses OpenAPI 3.1, is a known issue that this is currently not fully supported by [Azure API Management](/azure/api-management/api-management-key-concepts)
2323
2424
## API evolution
2525

26-
Historically, Azure OpenAI received monthly updates of new API versions. To take advantage of each new feature required constantly updating code and environment variables with each new API release. Azure OpenAI also required the extra step of using Azure specific clients which created additional overhead when migrating code between OpenAI and Azure OpenAI. Starting in May 2025, you can now opt-in to our next generation of Azure OpenAI APIs which add support for:
26+
Historically, Azure OpenAI received monthly updates of new API versions. To take advantage of each new feature required constantly updating code and environment variables with each new API release. Azure OpenAI also required the extra step of using Azure specific clients which created overhead when migrating code between OpenAI and Azure OpenAI. Starting in May 2025, you can now opt in to our next generation of Azure OpenAI APIs which add support for:
2727

2828
- Access to the latest features with no need to update `api-version` each month.
2929
- OpenAI client support with minimal code changes to swap between OpenAI and Azure OpenAI.
3030

31-
For the initial preview launch we are only supporting a subset of the dataplane inference API. While in preview, operations may have incomplete functionality that will be continually expanded.
31+
For the initial preview launch we are only supporting a subset of the inference API. While in preview, operations may have incomplete functionality that will be continually expanded.
3232

3333
## Code changes
3434

35-
# [API Key)](#tab/key)
35+
# [API Key](#tab/key)
3636

3737
### Last generation API
3838

@@ -79,9 +79,9 @@ print(response.model_dump_json(indent=2))
7979
- `extra_headers={"Authorization": f"Bearer {token.token}"}` passes the Microsoft Entra ID token to handle secure authentication.
8080
- `extra_query={"api-version": "preview"}` indicates that the version-less always up-to-date preview API is being used.
8181

82-
Once we release the GA next generation API we will support two values `latest` and `preview`. If `api-version` is not passed traffic is automatically routed to the `latest` GA version. Currently only `preview` is supported.
82+
Once we release the GA next generation API, we will support two values `latest` and `preview`. If `api-version` is not passed traffic is automatically routed to the `latest` GA version. Currently only `preview` is supported.
8383

84-
# [Microsoft Entra ID](#tab/entra)\
84+
# [Microsoft Entra ID](#tab/entra)
8585

8686
### Last generation API
8787

@@ -135,7 +135,7 @@ print(response.model_dump_json(indent=2))
135135
- `extra_headers={"Authorization": f"Bearer {token.token}"}` passes the Microsoft Entra ID token to handle secure authentication.
136136
- `extra_query={"api-version": "preview"}` indicates that the version-less always up-to-date preview API is being used.
137137

138-
Once we release the GA next generation API we will support two values `latest` and `preview`. If `api-version` is not passed traffic is automatically routed to the `latest` GA version. Currently only `preview` is supported.
138+
Once we release the GA next generation API, we will support two values `latest` and `preview`. If `api-version` is not passed traffic is automatically routed to the `latest` GA version. Currently only `preview` is supported.
139139

140140
# [REST](#tab/rest)
141141

@@ -330,7 +330,7 @@ Azure OpenAI API latest releases:
330330
- **Breaking Change**: Enhancements parameters removed. This impacts the `gpt-4` **Version:** `vision-preview` model.
331331
- [timestamp_granularities](https://github.com/Azure/azure-rest-api-specs/blob/fbc90d63f236986f7eddfffe3dca6d9d734da0b2/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json#L5217) parameter added.
332332
- [`audioWord`](https://github.com/Azure/azure-rest-api-specs/blob/fbc90d63f236986f7eddfffe3dca6d9d734da0b2/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json#L5286) object added.
333-
- Additional TTS [`response_formats`: wav & pcm](https://github.com/Azure/azure-rest-api-specs/blob/fbc90d63f236986f7eddfffe3dca6d9d734da0b2/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json#L5333).
333+
- Additional TTS [`response_formats: wav & pcm`](https://github.com/Azure/azure-rest-api-specs/blob/fbc90d63f236986f7eddfffe3dca6d9d734da0b2/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json#L5333).
334334

335335
## Latest GA API release
336336

0 commit comments

Comments
 (0)