Skip to content

Commit 4447c55

Browse files
jborsecnikjborsecnik
authored
Merge pull request #206832 from aahill/august-model-updates
model version article updates
2 parents bca5d18 + f856f6a commit 4447c55

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

‎articles/cognitive-services/language-service/concepts/model-lifecycle.md‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.service: cognitive-services
99
ms.subservice: language-service
1010
ms.custom: event-tier1-build-2022
1111
ms.topic: conceptual
12-
ms.date: 07/27/2022
12+
ms.date: 08/15/2022
1313
ms.author: aahi
1414
---
1515

@@ -21,21 +21,20 @@ Language service features utilize AI models that are versioned. We update the la
2121

2222
### Expiration timeline
2323

24-
Our standard (not customized) language service is built upon AI models that we call pre-trained models. We update the language service with new model versions every few months to improve model accuracy, support, and quality.
24+
Our standard (not customized) language service features are built upon AI models that we call pre-trained models. We update the language service with new model versions every few months to improve model accuracy, support, and quality.
2525

26-
Pre-built Model Capabilities: As new models and new functionality become available and older, less accurate models are retired. Unless otherwise noted, retired pre-built models will be automatically updated to the newest model version.
26+
As new models and functionalities become available, older less accurate models are deprecated. To ensure you are using the latest model version and avoid interruptions to your applications, we highly recommend using the default model-version parameter (`latest`) in your API calls. After their deprecation date, pre-built model versions will no longer be functional and your implementation may be broken.
2727

28-
During the model version deprecation period, API calls to the soon-to-be retired model versions will return a warning. After model-version deprecation, API calls to deprecated model-versions will return responses using the newest model version with an additional warning message. So, your implementation will never break, but results might change.
29-
30-
The model-version retirement period is defined as: the period of time from a release of a newer model-version for the capability, until a specific older version is deprecated. This period is defined as six months for stable model versions, and three months for previews. For example, a stable model-version `2021-01-01` will be deprecated six months after a successor model-version `2021-07-01` is released, on January 1, 2022. Preview capabilities in preview APIs do not maintain a minimum retirement period and can be deprecated at any time.
28+
Stable (not preview) model versions are deprecated six months after the release of another stable model version. Features in preview don't maintain a minimum retirement period and may be deprecated at any time.
3129

3230

3331
#### Choose the model-version used on your data
3432

35-
By default, API requests will use the latest Generally Available model. You can use an optional parameter to select the version of the model to be used.
33+
By default, API requests will use the latest Generally Available model. You can use an optional parameter to select the version of the model to be used (not recommended).
3634

3735
> [!TIP]
3836
> If you’re using the SDK for C#, Java, JavaScript or Python, see the reference documentation for information on the appropriate model-version parameter.
37+
3938
For synchronous endpoints, use the `model-version` query parameter. For example:
4039

4140
`POST <your-language-resource-endpoint>/language/:analyze-text?api-version=2022-05-01&model-version=2022-06-01`.
@@ -50,19 +49,26 @@ The model-version used in your API request will be included in the response obje
5049
Use the table below to find which model versions are supported by each feature:
5150

5251

53-
| Feature | Supported versions | Latest Generally Available version | Latest preview version |
54-
|-----------------------------------------------------|---------------------------------------------------------------------|------------------------------------|------------------------|
55-
| Sentiment Analysis and opinion mining | `2019-10-01`, `2020-04-01`, `2021-10-01`, `2022-06-01` | `2022-06-01` | |
56-
| Language Detection | `2021-11-20` | `2021-11-20` | |
57-
| Entity Linking | `2021-06-01` | `2021-06-01` | |
58-
| Named Entity Recognition (NER) | `2021-06-01` | `2021-06-01` | |
59-
| Personally Identifiable Information (PII) detection | `2020-07-01`, `2021-01-15` | `2021-01-15` | |
60-
| PII detection for conversations (Preview) | `2022-05-15-preview` | | `2022-05-15-preview` |
61-
| Question answering | `2021-10-01` | `2021-10-01` | |
62-
| Text Analytics for health | `2021-05-15`, `2022-03-01` | `2022-03-01` | |
63-
| Key phrase extraction | `2019-10-01`, `2020-07-01`, `2021-06-01`, `2022-07-01` | `2022-07-01` | |
64-
| Document summarization (preview) | `2021-08-01` | | `2021-08-01` |
65-
| Conversation summarization (preview) | `2022-05-15-preview` | | `2022-05-15-preview` |
52+
| Feature | Supported versions | Model versions to be deprecated |
53+
|-----------------------------------------------------|-----------------------------|------------------------|
54+
| Sentiment Analysis and opinion mining | `2021-10-01`, `2022-06-01*` | `2019-10-01`, `2020-04-01` |
55+
| Language Detection | `2021-11-20*` | `2019-10-01`, `2020-07-01`, `2020-09-01`, `2021-01-05` |
56+
| Entity Linking | `2021-06-01*` | `2019-10-01`, `2020-02-01` |
57+
| Named Entity Recognition (NER) | `2021-06-01*` | `2019-10-01`, `2020-02-01`, `2020-04-01`, `2021-01-15` |
58+
| Personally Identifiable Information (PII) detection | `2020-07-01`, `2021-01-15*` | `2019-10-01`, `2020-02-01`, `2020-04-01`, `2020-07-01` |
59+
| PII detection for conversations (Preview) | `2022-05-15-preview**` | |
60+
| Question answering | `2021-10-01*` | |
61+
| Text Analytics for health | `2021-05-15`, `2022-03-01*` | |
62+
| Key phrase extraction | `2021-06-01`, `2022-07-01*` | `2019-10-01`, `2020-07-01` |
63+
| Document summarization (preview) | `2021-08-01*` | |
64+
| Conversation summarization (preview) | `2022-05-15-preview**` | |
65+
66+
\* Latest Generally Available (GA) model version
67+
68+
\*\* Latest preview version
69+
70+
> [!IMPORTANT]
71+
> The versions listed for deprecation will be unavailable for use after October 30, 2022.
6672
6773
## Custom features
6874

0 commit comments

Comments
 (0)