Skip to content

Commit f2a672a

Browse files
committed
update
1 parent 99167b9 commit f2a672a

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services: cognitive-services
55
manager: nitinme
66
ms.service: azure-ai-openai
77
ms.topic: conceptual
8-
ms.date: 08/26/2025
8+
ms.date: 09/05/2025
99
author: mrbullwinkle
1010
ms.author: mbullwin
1111
recommendations: false
@@ -22,14 +22,14 @@ This article is to help you understand the support lifecycle for Azure OpenAI AP
2222
2323
## API evolution
2424

25-
Previously, 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.
25+
Previously, 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.
2626

2727
Starting in August 2025, you can now opt in to our next generation v1 Azure OpenAI APIs which add support for:
2828

2929
- Ongoing access to the latest features with no need specify new `api-version`'s each month.
3030
- Faster API release cycle with new features launching more frequently.
3131
- OpenAI client support with minimal code changes to swap between OpenAI and Azure OpenAI when using key-based authentication.
32-
- OpenAI client support for token based authentication and automatic token refresh without the need to take a dependency on a separate Azure OpenAI client will be added for all currently supported languages. Adding support for this functionality is **coming soon** for the [Python](https://pypi.org/project/openai/), and the [TypeScript/JavaScript](https://github.com/openai/openai-node) libraries. .NET, Java, and Go support is currently available in preview.
32+
- OpenAI client support for token based authentication and automatic token refresh without the need to take a dependency on a separate Azure OpenAI client.
3333

3434
Access to new API calls that are still in preview will be controlled by passing feature specific preview headers allowing you to opt in to the features you want, without having to swap API versions. Alternatively, some features will indicate preview status through their API path and don't require an additional header.
3535

@@ -38,7 +38,7 @@ Examples:
3838
- `/openai/v1/evals` is in preview and requires passing an `"aoai-evals":"preview"` header.
3939
- `/openai/v1/fine_tuning/alpha/graders/` is in preview and requires no custom header due to the presence of `alpha` in the API path.
4040

41-
For the initial v1 GA API launch we're only supporting a subset of the inference and authoring API capabilities. We'll be rapidly adding support for more capabilities soon.
41+
For the initial v1 Generally Available (GA) API launch we're only supporting a subset of the inference and authoring API capabilities. All GA features are supported for use in production. We'll be rapidly adding support for more capabilities soon.
4242

4343
## Code changes
4444

@@ -116,7 +116,7 @@ print(response.model_dump_json(indent=2))
116116
### Next generation API
117117

118118
> [!IMPORTANT]
119-
> Handling automatic token refresh was previously handled through use of the `AzureOpenAI()` client. The v1 API will remove this dependency, but adding automatic token refresh support to the `OpenAI()` client is still in progress. The example below is the current proposed structure, but it may be subject to change. The code below is for example purposes only, and won't execute successfully until the updated OpenAI library is released.
119+
> Handling automatic token refresh was previously handled through use of the `AzureOpenAI()` client. The v1 API removes this dependency, by adding automatic token refresh support to the `OpenAI()` client.
120120
121121
```python
122122
from openai import OpenAI
@@ -128,7 +128,7 @@ token_provider = get_bearer_token_provider(
128128

129129
client = OpenAI(
130130
base_url = "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
131-
api_key=lamba: fetch_azure_token()
131+
api_key = token_provider
132132
)
133133

134134
response = client.responses.create(
@@ -141,7 +141,7 @@ print(response.model_dump_json(indent=2))
141141

142142
- `AzureOpenAI()` is used to take advantage of automatic token refresh provided by `azure_ad_token_provider`.
143143
- `base_url` passes the Azure OpenAI endpoint and `/openai/v1` is appended to the endpoint address.
144-
- `api_key` parameter will call `fetch_azure_token()`, enabling automatic retrieval and refresh of an authentication token instead of using a static API key.
144+
- `api_key` parameter is set to `token_provider`, enabling automatic retrieval and refresh of an authentication token instead of using a static API key.
145145

146146
# [REST](#tab/rest)
147147

@@ -269,6 +269,8 @@ curl -X POST https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses?api
269269

270270
### Status
271271

272+
Generally Available features are supported for use in production.
273+
272274
| API Path | Status |
273275
|----------------------------------------|---------------------|
274276
| `/openai/v1/chat/completions` | Generally Available |

0 commit comments

Comments
 (0)