Azure OpenAI API preview lifecycle
This article is to help you understand the support lifecycle for the Azure OpenAI API previews. New preview APIs target a monthly release cadence. Whenever possible we recommend using either the latest GA, or preview API releases.
Note
The 2023-06-01-preview
API and the 2023-10-01-preview
API remain supported at this time.
Latest preview API releases
Azure OpenAI API latest release:
- Inference: 2024-09-01-preview
- Authoring: 2024-08-01-preview
This version contains support for the latest Azure OpenAI features including:
- Assistants V2 [Added in 2024-05-01-preview]
- Embeddings
encoding_format
anddimensions
parameters [Added in 2024-03-01-preview] - Assistants API. [Added in 2024-02-15-preview]
- Text to speech. [Added in 2024-02-15-preview]
- DALL-E 3. [Added in 2023-12-01-preview]
- Fine-tuning
gpt-35-turbo
,babbage-002
, anddavinci-002
models.[Added in 2023-10-01-preview] - Whisper. [Added in 2023-09-01-preview]
- Function calling [Added in 2023-07-01-preview]
- Retrieval augmented generation with your data feature. [Added in 2023-06-01-preview]
Changes between 2024-09-01-preview and 2024-08-01-preview
max_completion_tokens
added to supporto1-preview
ando1-mini
models.max_tokens
does not work with the o1 series models.parallel_tool_calls
added.completion_tokens_details
&reasoning_tokens
added.stream_options
&include_usage
added.
Changes between 2024-07-01-preview and 2024-08-01-preview API specification
- Structured outputs support.
- Large file upload API added.
- On your data changes:
- Mongo DB integration.
role_information
parameter removed.rerank_score
added to citation object.- AML datasource removed.
- AI Search vectorization integration improvements.
Changes between 2024-5-01-preview and 2024-07-01-preview API specification
- Batch API support added
- Vector store chunking strategy parameters
max_num_results
that the file search tool should output.
Changes between 2024-04-01-preview and 2024-05-01-preview API specification
- Assistants v2 support - File search tool and vector storage
- Fine-tuning checkpoints, seed, events
- On your data updates
- DALL-E 2 now supports model deployment and can be used with the latest preview API.
- Content filtering updates
Changes between 2024-03-01-preview and 2024-04-01-preview API specification
- Breaking Change: Enhancements parameters removed. This impacts the
gpt-4
Version:vision-preview
model. - timestamp_granularities parameter added.
audioWord
object added.- Additional TTS
response_formats
: wav & pcm.
Latest GA API release
Azure OpenAI API version 2024-06-01 is currently the latest GA API release. This API version is the replacement for the previous 2024-02-01
GA API release.
This version contains support for the latest GA features like Whisper, DALL-E 3, fine-tuning, on your data, etc. Any preview features that were released after the 2023-12-01-preview
release like Assistants, TTS, certain on your data datasources, are only supported in the latest preview API releases.
Updating API versions
We recommend first testing the upgrade to new API versions to confirm there's no impact to your application from the API update before making the change globally across your environment.
If you're using the OpenAI Python or JavaScript client libraries, or the REST API, you'll need to update your code directly to the latest preview API version.
If you're using one of the Azure OpenAI SDKs for C#, Go, or Java, you'll instead need to update to the latest version of the SDK. Each SDK release is hardcoded to work with specific versions of the Azure OpenAI API.