You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/openai/api-version-lifecycle.md
+32-23Lines changed: 32 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ services: cognitive-services
5
5
manager: nitinme
6
6
ms.service: azure-ai-openai
7
7
ms.topic: conceptual
8
-
ms.date: 05/22/2025
8
+
ms.date: 05/25/2025
9
9
author: mrbullwinkle
10
10
ms.author: mbullwin
11
11
recommendations: false
@@ -23,10 +23,10 @@ This article is to help you understand the support lifecycle for Azure OpenAI AP
23
23
24
24
## API evolution
25
25
26
-
Historically, Azure OpenAI received monthly updates of new API versions. Taking advantage of new features 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:
26
+
Historically, Azure OpenAI received monthly updates of new API versions. Taking advantage of new features 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 v1 Azure OpenAI APIs which add support for:
27
27
28
28
- Ongoing access to the latest features with no need to update `api-version` each month.
29
-
- OpenAI client support with minimal code changes to swap between OpenAI and Azure OpenAI.
29
+
- OpenAI client support with minimal code changes to swap between OpenAI and Azure OpenAI when using key-based authentication.
30
30
31
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.
-`OpenAI()` client is used instead of `AzureOpenAI()`.
78
78
-`base_url` passes the Azure OpenAI endpoint and `/openai/v1` is appended to the endpoint address.
79
-
-`extra_query={"api-version": "preview"}` indicates that the version-less always up-to-date preview API is being used.
79
+
-`default_query={"api-version": "preview"}` indicates that the version-less always up-to-date preview API is being used.
80
80
81
-
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.
81
+
Once we release the GA next generation v1 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.
-`OpenAI()`client is used instead of `AzureOpenAI()`.
134
+
-`AzureOpenAI()` is used to take advantage of automatic token refresh provided by `azure_ad_token_provider`.
133
135
-`base_url` passes the Azure OpenAI endpoint and `/openai/v1` is appended to the endpoint address.
134
-
-`extra_headers={"Authorization": f"Bearer {token.token}"}` passes the Microsoft Entra ID token to handle secure authentication.
135
-
-`extra_query={"api-version": "preview"}` indicates that the version-less always up-to-date preview API is being used.
136
+
-`api-version="preview"` indicates that the version-less always up-to-date preview API is being used.
136
137
137
-
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 v1 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
139
139
140
# [REST](#tab/rest)
140
141
@@ -260,11 +261,19 @@ curl -X POST "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses?ap
0 commit comments