Skip to content

Commit dec48f3

Browse files
authored
Merge pull request #253745 from mrbullwinkle/mrb_10_04_2023_new_models_page
[Azure OpenAI] Model page update
2 parents 4d87db8 + eda2b79 commit dec48f3

File tree

6 files changed

+225
-203
lines changed

6 files changed

+225
-203
lines changed

articles/ai-services/openai/concepts/models.md

Lines changed: 4 additions & 200 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ titleSuffix: Azure OpenAI
44
description: Learn about the different model capabilities that are available with Azure OpenAI.
55
ms.service: azure-ai-openai
66
ms.topic: conceptual
7-
ms.date: 09/15/2023
7+
ms.date: 10/04/2023
88
ms.custom: event-tier1-build-2022, references_regions, build-2023, build-2023-dataai
99
manager: nitinme
1010
author: mrbullwinkle #ChrisHMSFT
@@ -86,7 +86,7 @@ These models can only be used with the Chat Completion API.
8686
| `gpt-4-32k` (0613) | Australia East<sup>1</sup>, Canada East, East US<sup>1</sup>, East US 2<sup>1</sup>, France Central<sup>1</sup>, Japan East<sup>1</sup>, Sweden Central, Switzerland North, UK South<sup>1</sup> | N/A | 32,768 | September 2021 |
8787

8888
<sup>1</sup> Due to high demand, availability is limited in the region<br>
89-
<sup>2</sup> Version `0314` of gpt-4 and gpt-4-32k will be retired no earlier than July 5, 2024. See [model updates](#model-updates) for model upgrade behavior.<br>
89+
<sup>2</sup> Version `0314` of gpt-4 and gpt-4-32k will be retired no earlier than July 5, 2024. See [model updates](../how-to/working-with-models.md#model-updates) for model upgrade behavior.<br>
9090

9191
### GPT-3.5 models
9292

@@ -99,7 +99,7 @@ GPT-3.5 Turbo is used with the Chat Completion API. GPT-3.5 Turbo (0301) can als
9999
| `gpt-35-turbo-16k` (0613) | Australia East, Canada East, East US, East US 2, France Central, Japan East, North Central US, Sweden Central, Switzerland North, UK South | N/A | 16,384 | Sep 2021 |
100100
| `gpt-35-turbo-instruct` (0914) | East US, Sweden Central | N/A | 4,097 | Sep 2021 |
101101

102-
<sup>1</sup> Version `0301` of gpt-35-turbo will be retired no earlier than July 5, 2024. See [model updates](#model-updates) for model upgrade behavior.
102+
<sup>1</sup> Version `0301` of gpt-35-turbo will be retired no earlier than July 5, 2024. See [model updates](../how-to/working-with-models.md#model-updates) for model upgrade behavior.
103103

104104
### Embeddings models
105105

@@ -125,204 +125,8 @@ These models can only be used with Embedding API requests.
125125
| --- | --- | --- | --- | --- |
126126
| whisper | North Central US, West Europe | N/A | 25 MB | N/A |
127127

128-
## Working with models
129-
130-
### Finding what models are available
131-
132-
You can get a list of models that are available for both inference and fine-tuning by your Azure OpenAI resource by using the [Models List API](/rest/api/cognitiveservices/azureopenaistable/models/list).
133-
134-
### Model updates
135-
136-
Azure OpenAI now supports automatic updates for select model deployments. On models where automatic update support is available, a model version drop-down will be visible in Azure OpenAI Studio under **Create new deployment** and **Edit deployment**:
137-
138-
:::image type="content" source="../media/models/auto-update.png" alt-text="Screenshot of the deploy model UI of Azure OpenAI Studio." lightbox="../media/models/auto-update.png":::
139-
140-
### Auto update to default
141-
142-
When **Auto-update to default** is selected your model deployment will be automatically updated within two weeks of a change in the default version.
143-
144-
If you are still in the early testing phases for inference models, we recommend deploying models with **auto-update to default** set whenever it is available.
145-
146-
### Specific model version
147-
148-
As your use of Azure OpenAI evolves, and you start to build and integrate with applications you may want to manually control model updates so that you can first test and validate that model performance is remaining consistent for your use case prior to upgrade.
149-
150-
When you select a specific model version for a deployment this version will remain selected until you either choose to manually update yourself, or once you reach the retirement date for the model. When the retirement date is reached the model will auto-upgrade to the default version at the time of retirement.
151-
152-
### GPT-35-Turbo 0301 and GPT-4 0314 retirement
153-
154-
The `gpt-35-turbo` (`0301`) and both `gpt-4` (`0314`) models will be retired no earlier than July 5, 2024. Upon retirement, deployments will automatically be upgraded to the default version at the time of retirement. If you would like your deployment to stop accepting completion requests rather than upgrading, then you will be able to set the model upgrade option to expire through the API. We will publish guidelines on this by September 1.
155-
156-
### Viewing deprecation dates
157-
158-
For currently deployed models, from Azure OpenAI Studio select **Deployments**:
159-
160-
:::image type="content" source="../media/models/deployments.png" alt-text="Screenshot of the deployment UI of Azure OpenAI Studio." lightbox="../media/models/deployments.png":::
161-
162-
To view deprecation/expiration dates for all available models in a given region from Azure OpenAI Studio select **Models** > **Column options** > Select **Deprecation fine tune** and **Deprecation inference**:
163-
164-
:::image type="content" source="../media/models/column-options.png" alt-text="Screenshot of the models UI of Azure OpenAI Studio." lightbox="../media/models/column-options.png":::
165-
166-
### Model deployment upgrade configuration
167-
168-
There are three distinct model deployment upgrade options which are configurable via REST API:
169-
170-
| Name | Description |
171-
|------|--------|
172-
| `OnceNewDefaultVersionAvailable` | Once a new version is designated as the default, the model deployment will auto-upgrade to the default version within two weeks of that designation change being made. |
173-
`OnceCurrentVersionExpired` | Once the retirement date is reached the model deployment will auto-upgrade to the current default version. |
174-
`NoAutoUpgrade` | The model deployment will never auto-upgrade. Once the retirement date is reached the model deployment will stop working. You will need to update your code referencing that deployment to point to a non-expired model deployment. |
175-
176-
To query the current model deployment settings including the deployment upgrade configuration for a given resource use [`Deployments List`](/rest/api/cognitiveservices/accountmanagement/deployments/list?tabs=HTTP#code-try-0)
177-
178-
```http
179-
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments?api-version=2023-05-01
180-
```
181-
182-
**Path parameters**
183-
184-
| Parameter | Type | Required? | Description |
185-
|--|--|--|--|
186-
| ```acountname``` | string | Required | The name of your Azure OpenAI Resource. |
187-
| ```resourceGroupName``` | string | Required | The name of the associated resource group for this model deployment. |
188-
| ```subscriptionId``` | string | Required | Subscription ID for the associated subscription. |
189-
| ```api-version``` | string | Required |The API version to use for this operation. This follows the YYYY-MM-DD format. |
190-
191-
**Supported versions**
192-
193-
- `2023-05-01` [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/1e71ad94aeb8843559d59d863c895770560d7c93/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json)
194-
195-
### Example response
196-
197-
```json
198-
{
199-
"id": "/subscriptions/{Subcription-GUID}/resourceGroups/{Resource-Group-Name}/providers/Microsoft.CognitiveServices/accounts/{Resource-Name}/deployments/text-davinci-003",
200-
"type": "Microsoft.CognitiveServices/accounts/deployments",
201-
"name": "text-davinci-003",
202-
"sku": {
203-
"name": "Standard",
204-
"capacity": 60
205-
},
206-
"properties": {
207-
"model": {
208-
"format": "OpenAI",
209-
"name": "text-davinci-003",
210-
"version": "1"
211-
},
212-
"versionUpgradeOption": "OnceNewDefaultVersionAvailable",
213-
"capabilities": {
214-
"completion": "true",
215-
"search": "true"
216-
},
217-
"raiPolicyName": "Microsoft.Default",
218-
"provisioningState": "Succeeded",
219-
"rateLimits": [
220-
{
221-
"key": "request",
222-
"renewalPeriod": 10,
223-
"count": 60
224-
},
225-
{
226-
"key": "token",
227-
"renewalPeriod": 60,
228-
"count": 60000
229-
}
230-
]
231-
}
232-
```
233-
234-
You can then take the settings from this list to construct an update model REST API call as described below if you want to modify the deployment upgrade configuration.
235-
236-
### Update & deploy models via the API
237-
238-
```http
239-
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}?api-version=2023-05-01
240-
```
241-
242-
**Path parameters**
243-
244-
| Parameter | Type | Required? | Description |
245-
|--|--|--|--|
246-
| ```acountname``` | string | Required | The name of your Azure OpenAI Resource. |
247-
| ```deploymentName``` | string | Required | The deployment name you chose when you deployed an existing model or the name you would like a new model deployment to have. |
248-
| ```resourceGroupName``` | string | Required | The name of the associated resource group for this model deployment. |
249-
| ```subscriptionId``` | string | Required | Subscription ID for the associated subscription. |
250-
| ```api-version``` | string | Required |The API version to use for this operation. This follows the YYYY-MM-DD format. |
251-
252-
**Supported versions**
253-
254-
- `2023-05-01` [Swagger spec](https://github.com/Azure/azure-rest-api-specs/blob/1e71ad94aeb8843559d59d863c895770560d7c93/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json)
255-
256-
**Request body**
257-
258-
This is only a subset of the available request body parameters. For the full list of the parameters, you can refer to the [REST API reference documentation](/rest/api/cognitiveservices/accountmanagement/deployments/create-or-update).
259-
260-
|Parameter|Type| Description |
261-
|--|--|--|
262-
|versionUpgradeOption | String | Deployment model version upgrade options:<br>`OnceNewDefaultVersionAvailable`<br>`OnceCurrentVersionExpired`<br>`NoAutoUpgrade`|
263-
|capacity|integer|This represents the amount of [quota](../how-to/quota.md) you are assigning to this deployment. A value of 1 equals 1,000 Tokens per Minute (TPM)|
264-
265-
#### Example request
266-
267-
```Bash
268-
curl -X PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource-group-temp/providers/Microsoft.CognitiveServices/accounts/docs-openai-test-001/deployments/text-embedding-ada-002-test-1?api-version=2023-05-01 \
269-
-H "Content-Type: application/json" \
270-
-H 'Authorization: Bearer YOUR_AUTH_TOKEN' \
271-
-d '{"sku":{"name":"Standard","capacity":1},"properties": {"model": {"format": "OpenAI","name": "text-embedding-ada-002","version": "2"},"versionUpgradeOption":"OnceCurrentVersionExpired"}}'
272-
```
273-
274-
> [!NOTE]
275-
> There are multiple ways to generate an authorization token. The easiest method for initial testing is to launch the Cloud Shell from the [Azure portal](https://portal.azure.com). Then run [`az account get-access-token`](/cli/azure/account?view=azure-cli-latest#az-account-get-access-token&preserve-view=true). You can use this token as your temporary authorization token for API testing.
276-
277-
#### Example response
278-
279-
```json
280-
{
281-
"id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-temp/providers/Microsoft.CognitiveServices/accounts/docs-openai-test-001/deployments/text-embedding-ada-002-test-1",
282-
"type": "Microsoft.CognitiveServices/accounts/deployments",
283-
"name": "text-embedding-ada-002-test-1",
284-
"sku": {
285-
"name": "Standard",
286-
"capacity": 1
287-
},
288-
"properties": {
289-
"model": {
290-
"format": "OpenAI",
291-
"name": "text-embedding-ada-002",
292-
"version": "2"
293-
},
294-
"versionUpgradeOption": "OnceCurrentVersionExpired",
295-
"capabilities": {
296-
"embeddings": "true",
297-
"embeddingsMaxInputs": "1"
298-
},
299-
"provisioningState": "Succeeded",
300-
"ratelimits": [
301-
{
302-
"key": "request",
303-
"renewalPeriod": 10,
304-
"count": 2
305-
},
306-
{
307-
"key": "token",
308-
"renewalPeriod": 60,
309-
"count": 1000
310-
}
311-
]
312-
},
313-
"systemData": {
314-
"createdBy": "[email protected]",
315-
"createdByType": "User",
316-
"createdAt": "2023-06-13T00:12:38.885937Z",
317-
"lastModifiedBy": "[email protected]",
318-
"lastModifiedByType": "User",
319-
"lastModifiedAt": "2023-06-13T02:41:04.8410965Z"
320-
},
321-
"etag": "\"{GUID}\""
322-
}
323-
```
324-
325128
## Next steps
326129

130+
- [Learn more about working with Azure OpenAI models](../how-to/working-with-models.md)
327131
- [Learn more about Azure OpenAI](../overview.md)
328132
- [Learn more about fine-tuning Azure OpenAI models](../how-to/fine-tuning.md)

0 commit comments

Comments
 (0)