Skip to content

Commit 7dadd58

Browse files
Merge pull request #268381 from mrbullwinkle/mrb_03_07_2024_march_preview_api
[Azure OpenAI] March Preview API release
2 parents ffa7402 + d4c1742 commit 7dadd58

File tree

3 files changed

+26
-4
lines changed

3 files changed

+26
-4
lines changed

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

Lines changed: 3 additions & 2 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: 02/29/2024
8+
ms.date: 03/07/2024
99
author: mrbullwinkle
1010
ms.author: mbullwin
1111
recommendations: false
@@ -21,11 +21,12 @@ This article is to help you understand the support lifecycle for the Azure OpenA
2121
2222
## Latest preview API release
2323

24-
Azure OpenAI API version [2024-02-15-preview](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json)
24+
Azure OpenAI API version [2024-03-01-preview](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/inference.json)
2525
is currently the latest preview release.
2626

2727
This version contains support for all the latest Azure OpenAI features including:
2828

29+
- [Embeddings `encoding_format` and `dimensions` parameters] [**Added in 2024-03-01-preview**]
2930
- [Assistants API](./assistants-reference.md). [**Added in 2024-02-15-preview**]
3031
- [DALL-E 3](./dall-e-quickstart.md). [**Added in 2023-12-01-preview**]
3132
- [Text to speech](./text-to-speech-quickstart.md). [**Added in 2024-02-15-preview**]

articles/ai-services/openai/reference.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to use Azure OpenAI's REST API. In this article, you lear
55
manager: nitinme
66
ms.service: azure-ai-openai
77
ms.topic: conceptual
8-
ms.date: 02/21/2024
8+
ms.date: 03/07/2024
99
author: mrbullwinkle
1010
ms.author: mbullwin
1111
recommendations: false
@@ -62,6 +62,7 @@ POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deploymen
6262
- `2023-09-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json)
6363
- `2023-12-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json)
6464
- `2024-02-15-preview`[Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json)
65+
- `2024-03-01-preview` [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/inference.json)
6566

6667
**Request body**
6768

@@ -146,13 +147,16 @@ POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deploymen
146147
- `2023-09-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json)
147148
- `2023-12-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json)
148149
- `2024-02-15-preview`[Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json)
150+
- `2024-03-01-preview` [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/inference.json)
149151

150152
**Request body**
151153

152154
| Parameter | Type | Required? | Default | Description |
153155
|--|--|--|--|--|
154156
| ```input```| string or array | Yes | N/A | Input text to get embeddings for, encoded as an array or string. The number of input tokens varies depending on what [model you're using](./concepts/models.md). Only `text-embedding-ada-002 (Version 2)` supports array input.|
155157
| ```user``` | string | No | Null | A unique identifier representing your end-user. This will help Azure OpenAI monitor and detect abuse. **Do not pass PII identifiers instead use pseudoanonymized values such as GUIDs** |
158+
| ```encoding_format```| string | No | `float`| The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`. <br><br>[Added in `2024-03-01-preview`].|
159+
| ```dimensions``` | integer | No | | The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. <br><br>[Added in `2024-03-01-preview`] |
156160

157161
#### Example request
158162

@@ -212,6 +216,8 @@ POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deploymen
212216
- `2023-09-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json)
213217
- `2023-12-01-preview` (retiring April 2, 2024) (This version or greater required for Vision scenarios) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview)
214218
- `2024-02-15-preview`[Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json)
219+
- `2024-03-01-preview` [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/inference.json)
220+
215221

216222

217223
**Request body**
@@ -1198,6 +1204,8 @@ POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deploymen
11981204
- `2023-09-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json)
11991205
- `2023-12-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json)
12001206
- `2024-02-15-preview`[Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json)
1207+
- `2024-03-01-preview` [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/inference.json)
1208+
12011209

12021210
**Request body**
12031211

@@ -1283,6 +1291,8 @@ POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deploymen
12831291
- `2023-09-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json)
12841292
- `2023-12-01-preview` (retiring April 2, 2024) [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json)
12851293
- `2024-02-15-preview`[Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json)
1294+
- `2024-03-01-preview` [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/inference.json)
1295+
12861296

12871297
**Request body**
12881298

articles/ai-services/openai/whats-new.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,23 @@ ms.custom:
1010
- ignite-2023
1111
- references_regions
1212
ms.topic: whats-new
13-
ms.date: 02/21/2024
13+
ms.date: 03/07/2024
1414
recommendations: false
1515
---
1616

1717
# What's new in Azure OpenAI Service
1818

19+
## March 2024
20+
21+
### 2024-03-01-preview API released
22+
23+
`2024-03-01-preview` has all the same functionality as `2024-02-15-preview` and adds two new parameters for embeddings:
24+
25+
- `encoding_format` allows you to specify the format to generate embeddings in `float`, or `base64`. The default is `float`.
26+
- `dimensions` allows you set the number of output embeddings. This parameter is only supported with the new third generation embeddings models: `text-embedding-3-large`, `text-embedding-3-small`. Typically larger embeddings are more expensive from a compute, memory, and storage perspective. Being able to adjust the number of dimensions allows more control over overall cost and performance. The `dimensions` parameter is not supported in all versions of the OpenAI 1.x Python library, to take advantage of this parameter we recommend upgrading to the latest version: `pip install openai --upgrade`.
27+
28+
If you are currently using a preview API version to take advantage of the latest features, we recommend consulting the [API version lifecycle](./api-version-deprecation.md) article to track how long your current API version will be supported.
29+
1930
## February 2024
2031

2132
### GPT-3.5-turbo-0125 model available

0 commit comments

Comments
 (0)