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/concepts/model-retirements.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ titleSuffix: Azure OpenAI
4
4
description: Learn about the model deprecations and retirements in Azure OpenAI.
5
5
ms.service: azure-ai-openai
6
6
ms.topic: conceptual
7
-
ms.date: 07/30/2024
7
+
ms.date: 08/01/2024
8
8
ms.custom:
9
9
manager: nitinme
10
10
author: mrbullwinkle
@@ -31,7 +31,7 @@ Azure OpenAI notifies customers of active Azure OpenAI Service deployments for m
31
31
32
32
1. At model launch, we programmatically designate a "not sooner than" retirement date (typically six months to one year out).
33
33
2. At least 60 days notice before model retirement for Generally Available (GA) models.
34
-
3. At least 14 days notice before preview model version upgrades.
34
+
3. At least 30 days notice before preview model version upgrades.
35
35
36
36
Retirements are done on a rolling basis, region by region.
37
37
@@ -102,7 +102,7 @@ These models are currently available for use in Azure OpenAI Service.
102
102
|`text-embedding-3-small`|| No earlier than Feb 2, 2025 |
103
103
|`text-embedding-3-large`|| No earlier than Feb 2, 2025 |
104
104
105
-
**<sup>1</sup>** We will notify all customers with these preview deployments at least two weeks before the start of the upgrades. We will publish an upgrade schedule detailing the order of regions and model versions that we will follow during the upgrades, and link to that schedule from here.
105
+
**<sup>1</sup>** We will notify all customers with these preview deployments at least 30 days before the start of the upgrades. We will publish an upgrade schedule detailing the order of regions and model versions that we will follow during the upgrades, and link to that schedule from here.
When your API is ready to go and is used by developers, you eventually need to make changes to that API and at the same time not disrupt callers of your API. It's also useful to let developers know about the changes you made.
20
20
21
-
In Azure API Management, use *revisions* to make non-breaking API changes so you can model and test changes safely. When ready, you can make a revision current and replace your current API.
21
+
In Azure API Management, use *revisions* to make nonbreaking API changes so you can model and test changes safely. When ready, you can make a revision current and replace your current API.
22
22
23
-
For background, see [Versions & revisions](https://azure.microsoft.com/blog/versions-revisions/) and [API Versioning with Azure API Management](https://azure.microsoft.com/blog/api-versioning-with-azure-api-management/).
23
+
For background, see [Versions](api-management-versions.md) and [Revisions](api-management-revisions.md).
24
24
25
25
In this tutorial, you learn how to:
26
26
27
27
> [!div class="checklist"]
28
28
> * Add a new revision
29
-
> * Make non-breaking changes to your revision
29
+
> * Make nonbreaking changes to your revision
30
30
> * Make your revision current and add a change log entry
31
31
> * Browse the developer portal to see changes and change log
32
+
> * Access an API revision
32
33
33
-
:::image type="content" source="media/api-management-getstarted-revise-api/azure-portal.png" alt-text="API revisions in the Azure portal":::
34
+
:::image type="content" source="media/api-management-getstarted-revise-api/azure-portal.png" alt-text="Screenshot of API revisions in the Azure portal." lightbox="media/api-management-getstarted-revise-api/azure-portal.png":::
34
35
35
36
## Prerequisites
36
37
@@ -41,24 +42,24 @@ In this tutorial, you learn how to:
41
42
## Add a new revision
42
43
43
44
1. Sign in to the [Azure portal](https://portal.azure.com), and go to your API Management instance.
44
-
1.Select**APIs**.
45
+
1.In the left menu, under **APIs**, select**APIs**.
45
46
2. Select **Demo Conference API** from the API list (or another API to which you want to add revisions).
46
47
3. Select the **Revisions** tab.
47
48
4. Select **+ Add revision**.
48
49
49
-
:::image type="content" source="media/api-management-getstarted-revise-api/07-add-revisions-01-add-new-revision.png" alt-text="Add API revision":::
50
+
:::image type="content" source="media/api-management-getstarted-revise-api/07-add-revisions-01-add-new-revision.png" alt-text="Screenshot of adding an API revision in the portal.":::
50
51
51
52
> [!TIP]
52
53
> You can also select **Add revision** in the context menu (**...**) of the API.
53
54
54
-
5. Provide a description for your new revision, to help remember what it'll be used for.
55
+
5. Provide a description for your new revision, to help remember what it is used for.
55
56
6. Select **Create**.
56
57
7. Your new revision is now created.
57
58
58
59
> [!NOTE]
59
60
> Your original API remains in **Revision 1**. This is the revision your users continue to call, until you choose to make a different revision current.
60
61
61
-
## Make non-breaking changes to your revision
62
+
## Make nonbreaking changes to your revision
62
63
63
64
1. Select **Demo Conference API** from the API list.
64
65
1. Select the **Design** tab near the top of the screen.
@@ -67,10 +68,10 @@ In this tutorial, you learn how to:
67
68
> [!TIP]
68
69
> Use the revision selector to switch between revisions that you wish to work on.
69
70
1. Select **+ Add Operation**.
70
-
1. Set your new operation to **POST**, and the Name, Display Name and URL of the operation as **test**.
71
+
1. Set your new operation to **POST**, and the **Display name**, **Name**, and **URL** of the operation as **test**.
:::image type="content" source="media/api-management-getstarted-revise-api/07-add-revisions-02-make-changes.png" alt-text="Screenshot showing how to add an operation in a revision in the portal.":::
74
75
1. You've now made a change to **Revision 2**. Use the **revision selector** near the top of the page to switch back to **Revision 1**.
75
76
1. Notice that your new operation doesn't appear in **Revision 1**.
76
77
@@ -84,7 +85,7 @@ In this tutorial, you learn how to:
84
85
1. Select the **Post to Public Change log for this API** checkbox, if you want to post notes about this change. Provide a description for your change that the developers can see, for example: **Testing revisions. Added new "test" operation.**
85
86
1.**Revision 2** is now current.
86
87
87
-
:::image type="content" source="media/api-management-getstarted-revise-api/revisions-menu.png" alt-text="Revision menu in Revisions window":::
88
+
:::image type="content" source="media/api-management-getstarted-revise-api/revisions-menu.png" alt-text="Screenshot of revision menu in Revisions window in the portal." lightbox="media/api-management-getstarted-revise-api/revisions-menu.png":::
88
89
89
90
### [Azure CLI](#tab/azure-cli)
90
91
@@ -146,22 +147,41 @@ az apim api release delete --resource-group apim-hello-word-resource-group \
146
147
147
148
If you've tried the [developer portal](api-management-howto-developer-portal-customize.md), you can review the API changes and change log there.
148
149
149
-
1. In the Azure portal, select **APIs**.
150
+
1. In the Azure portal, navigate to your API Management instance.
151
+
1. In the left menu, under **APIs**, select **APIs**.
150
152
1. Select **Developer portal** from the top menu.
151
153
1. In the developer portal, select **APIs**, and then select **Demo Conference API**.
152
154
1. Notice your new **test** operation is now available.
153
155
1. Select **Changelog** near the API name.
154
156
1. Notice that your change log entry appears in the list.
155
157
156
-
## Next steps
158
+
159
+
## Access an API revision
160
+
161
+
Each revision to your API can be accessed using a specially formed URL. Add `;rev={revisionNumber}` at the end of your API URL path, but before the query string, to access a specific revision of that API. For example, you might use this URL to access revision 2 of the Demo Conference API:
You can find the URL paths for your API's revisions on the **Revisions** tab in the Azure portal.
166
+
167
+
:::image type="content" source="media/transform-api/revision-url-path.png" alt-text="Screenshot of revision URLs in the portal.":::
168
+
169
+
> [!TIP]
170
+
> You can access the *current* revision of your API using the API path without the `;rev` string, in addition to the full URL that appends `;rev={revisionNumber}` to your API path.
171
+
172
+
173
+
## Summary
157
174
158
175
In this tutorial, you learned how to:
159
176
160
177
> [!div class="checklist"]
161
178
> * Add a new revision
162
-
> * Make non-breaking changes to your revision
179
+
> * Make nonbreaking changes to your revision
163
180
> * Make your revision current and add a change log entry
164
181
> * Browse the developer portal to see changes and change log
0 commit comments