Skip to content

Commit 5ad0e5b

Browse files
authored
Merge pull request #3233 from laujan/update-preview
update preview dates
2 parents 67bf4b8 + 9ea2677 commit 5ad0e5b

File tree

9 files changed

+49
-49
lines changed

9 files changed

+49
-49
lines changed

articles/ai-services/document-intelligence/concept/add-on-capabilities.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: jaep3347
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 01/15/2025
9+
ms.date: 02/27/2025
1010
ms.author: lajanuar
1111
monikerRange: '>=doc-intel-3.1.0'
1212
---
@@ -93,7 +93,7 @@ The task of recognizing small text from large-size documents, like engineering d
9393
### [REST API](#tab/rest-api)
9494

9595
```bash
96-
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-02-29-preview&features=ocrHighResolution
96+
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-11-30&features=ocrHighResolution
9797
```
9898

9999
### [Sample code](#tab/sample-code)
@@ -362,7 +362,7 @@ The `ocr.formula` capability extracts all identified formulas, such as mathemati
362362
### [REST API](#tab/rest-api)
363363

364364
```bash
365-
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-02-29-preview&features=formulas
365+
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-11-30&features=formulas
366366
```
367367

368368
### [Sample code](#tab/sample-code)
@@ -509,7 +509,7 @@ The `ocr.font` capability extracts all font properties of text extracted in the
509509
### [REST API](#tab/rest-api)
510510

511511
```bash
512-
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-02-29-preview&features=styleFont
512+
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-11-30&features=styleFont
513513
```
514514

515515
### [Sample code](#tab/sample-code)
@@ -766,7 +766,7 @@ The `ocr.barcode` capability extracts all identified barcodes in the `barcodes`
766766
### [REST API](#tab/rest-api)
767767

768768
```bash
769-
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-02-29-preview&features=barcodes
769+
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-11-30&features=barcodes
770770
```
771771

772772
### [Sample code](#tab/sample-code)
@@ -875,7 +875,7 @@ Adding the `languages` feature to the `analyzeResult` request predicts the detec
875875
### [REST API](#tab/rest-api)
876876

877877
```bash
878-
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-02-29-preview&features=languages
878+
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-11-30&features=languages
879879
```
880880

881881
### [Sample code](#tab/sample-code)
@@ -1025,7 +1025,7 @@ Keys can also exist in isolation when the model detects that a key exists, with
10251025
### REST API
10261026
10271027
```bash
1028-
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-02-29-preview&features=keyValuePairs
1028+
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-11-30&features=keyValuePairs
10291029
```
10301030
10311031
## Query Fields
@@ -1065,7 +1065,7 @@ For query field extraction, specify the fields you want to extract and Document
10651065
### [REST API](#tab/rest-api)
10661066
10671067
```bash
1068-
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-02-29-preview&features=queryFields&queryFields=TERMS
1068+
{your-resource-endpoint}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2024-11-30&features=queryFields&queryFields=TERMS
10691069
```
10701070
10711071
### [Sample code](#tab/sample-code)

articles/ai-services/document-intelligence/concept/incremental-classifier.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 11/19/2024
9+
ms.date: 02/27/2025
1010
ms.author: vikurpad
1111
ms.custom:
1212
monikerRange: '>=doc-intel-4.0.0'
@@ -50,13 +50,13 @@ Incremental training is useful when you want to improve the quality of a custom
5050
5151
### Create an incremental classifier build request
5252

53-
The incremental classifier build request is similar to the [`classify document` build request](/rest/api/aiservices/document-classifiers?view=rest-aiservices-v4.0%20(2024-02-29-preview)&preserve-view=true) but includes the new `baseClassifierId` property. The `baseClassifierId` is set to the existing classifier that you want to extend. You also need to provide the `docTypes` for the different document types in the sample set. By providing a `docType` that exists in the baseClassifier, the samples provided in the request are added to the samples provided when the base classifier was trained. New `docType` values added in the incremental training are only added to the new classifier. The process to specify the samples remains unchanged. For more information, *see* [training a classifier model](../train/custom-classifier.md#training-a-model).
53+
The incremental classifier build request is similar to the [`classify document` build request](/rest/api/aiservices/document-classifiers?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) but includes the new `baseClassifierId` property. The `baseClassifierId` is set to the existing classifier that you want to extend. You also need to provide the `docTypes` for the different document types in the sample set. By providing a `docType` that exists in the baseClassifier, the samples provided in the request are added to the samples provided when the base classifier was trained. New `docType` values added in the incremental training are only added to the new classifier. The process to specify the samples remains unchanged. For more information, *see* [training a classifier model](../train/custom-classifier.md#training-a-model).
5454

5555
### Sample POST request
5656

5757
***Sample `POST` request to build an incremental document classifier***
5858

59-
**`POST` {your-endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview**
59+
**`POST` {your-endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30**
6060

6161
```json
6262
{
@@ -94,7 +94,7 @@ Upon successful completion:
9494

9595
***Sample `GET` request to retrieve the result of an incremental document classifier***
9696

97-
**`GET` {your-endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-02-29-preview**
97+
**`GET` {your-endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-11-30**
9898

9999
```json
100100

@@ -103,7 +103,7 @@ Upon successful completion:
103103
"description": "Classifier description",
104104
"createdDateTime": "2022-07-30T00:00:00Z",
105105
"expirationDateTime": "2023-01-01T00:00:00Z",
106-
"apiVersion": "2024-02-29-preview",
106+
"apiVersion": "2024-11-30",
107107

108108
"baseClassifierId": "myOriginalClassifier",
109109

articles/ai-services/document-intelligence/concept/retrieval-augmented-generation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 02/07/2025
9+
ms.date: 02/27/2025
1010
ms.author: lajanuar
1111
monikerRange: '>=doc-intel-3.1.0'
1212
---
@@ -61,7 +61,7 @@ The Document Intelligence Layout model **2024-11-30 (GA)** supports the followin
6161

6262
* [Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio).
6363

64-
* [REST API](/rest/api/aiservices/document-models/build-model?view=rest-aiservices-2024-02-29-preview&preserve-view=true&branch=docintelligence&tabs=HTTP).
64+
* [REST API](/rest/api/aiservices/document-models/build-model?view=rest-aiservices-2024-11-30&preserve-view=true&branch=docintelligence&tabs=HTTP).
6565

6666
* [.NET • Java • JavaScript • Python programming language client libraries (`SDK`s).](../sdk-overview-v4-0.md#supported-programming-languages)
6767

articles/ai-services/document-intelligence/how-to-guides/disaster-recovery.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: how-to
9-
ms.date: 02/20/2025
9+
ms.date: 02/27/2025
1010
ms.author: lajanuar
1111
---
1212

@@ -66,7 +66,7 @@ The process for copying a custom model consists of the following steps:
6666
The following HTTP request gets copy authorization from your target resource. You need to enter the endpoint and key of your target resource as headers.
6767

6868
```http
69-
POST https://<your-resource-endpoint>/documentintelligence/documentModels:authorizeCopy?api-version=2024-02-29-preview
69+
POST https://<your-resource-endpoint>/documentintelligence/documentModels:authorizeCopy?api-version=2024-11-30
7070
Ocp-Apim-Subscription-Key: {<your-key>}
7171
```
7272

@@ -97,7 +97,7 @@ You receive a `200` response code with response body that contains the JSON payl
9797
The following HTTP request starts the copy operation on the source resource. You need to enter the endpoint and key of your source resource as the url and header. Notice that the request URL contains the model ID of the source model you want to copy.
9898

9999
```http
100-
POST https://<your-resource-endpoint>/documentintelligence/documentModels/{modelId}:copyTo?api-version=2024-02-29-preview
100+
POST https://<your-resource-endpoint>/documentintelligence/documentModels/{modelId}:copyTo?api-version=2024-11-30
101101
Ocp-Apim-Subscription-Key: {<your-key>}
102102
```
103103

@@ -118,7 +118,7 @@ You receive a `202\Accepted` response with an Operation-Location header. This va
118118

119119
```http
120120
HTTP/1.1 202 Accepted
121-
Operation-Location: https://<your-resource-endpoint>.cognitiveservices.azure.com/documentintelligence/operations/{operation-id}?api-version=2024-02-29-preview
121+
Operation-Location: https://<your-resource-endpoint>.cognitiveservices.azure.com/documentintelligence/operations/{operation-id}?api-version=2024-11-30
122122
```
123123

124124
> [!NOTE]
@@ -127,7 +127,7 @@ Operation-Location: https://<your-resource-endpoint>.cognitiveservices.azure.com
127127
## Track Copy progress
128128

129129
```console
130-
GET https://<your-resource-endpoint>.cognitiveservices.azure.com/documentintelligence/operations/{<operation-id>}?api-version=2024-02-29-preview
130+
GET https://<your-resource-endpoint>.cognitiveservices.azure.com/documentintelligence/operations/{<operation-id>}?api-version=2024-11-30
131131
Ocp-Apim-Subscription-Key: {<your-key>}
132132
```
133133

@@ -136,7 +136,7 @@ Ocp-Apim-Subscription-Key: {<your-key>}
136136
You can also use the **[`Get model`](/rest/api/aiservices/document-models/get-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)** API to track the status of the operation by querying the target model. Call the API using the target model ID that you copied down from the [`Generate copy authorization` request](#generate-copy-authorization-request) response.
137137

138138
```http
139-
GET https://<your-resource-endpoint>/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview" -H "Ocp-Apim-Subscription-Key: <your-key>
139+
GET https://<your-resource-endpoint>/documentintelligence/documentModels/{modelId}?api-version=2024-11-30" -H "Ocp-Apim-Subscription-Key: <your-key>
140140
```
141141

142142
In the response body, you see information about the model. Check the `"status"` field for the status of the model.
@@ -156,7 +156,7 @@ The following code snippets use cURL to make API calls. You also need to fill in
156156
**Request**
157157

158158
```bash
159-
curl -i -X POST "<your-resource-endpoint>/documentintelligence/documentModels:authorizeCopy?api-version=2024-02-29-preview"
159+
curl -i -X POST "<your-resource-endpoint>/documentintelligence/documentModels:authorizeCopy?api-version=2024-11-30"
160160
-H "Content-Type: application/json"
161161
-H "Ocp-Apim-Subscription-Key: <YOUR-KEY>"
162162
--data-ascii "{
@@ -183,7 +183,7 @@ curl -i -X POST "<your-resource-endpoint>/documentintelligence/documentModels:au
183183
**Request**
184184

185185
```bash
186-
curl -i -X POST "<your-resource-endpoint>/documentintelligence/documentModels/{modelId}:copyTo?api-version=2024-02-29-preview"
186+
curl -i -X POST "<your-resource-endpoint>/documentintelligence/documentModels/{modelId}:copyTo?api-version=2024-11-30"
187187
-H "Content-Type: application/json"
188188
-H "Ocp-Apim-Subscription-Key: <YOUR-KEY>"
189189
--data-ascii "{
@@ -201,7 +201,7 @@ curl -i -X POST "<your-resource-endpoint>/documentintelligence/documentModels/{m
201201

202202
```http
203203
HTTP/1.1 202 Accepted
204-
Operation-Location: https://<your-resource-endpoint>.cognitiveservices.azure.com/documentintelligence/operations/{operation-id}?api-version=2024-02-29-preview
204+
Operation-Location: https://<your-resource-endpoint>.cognitiveservices.azure.com/documentintelligence/operations/{operation-id}?api-version=2024-11-30
205205
```
206206

207207
### Track copy operation progress
@@ -233,7 +233,7 @@ The process for copying a custom model consists of the following steps:
233233
The following HTTP request gets copy authorization from your target resource. You need to enter the endpoint and key of your target resource as headers.
234234

235235
```http
236-
POST https://{TARGET_FORM_RECOGNIZER_RESOURCE_ENDPOINT}/formrecognizer/documentModels:authorizeCopy?api-version=2024-02-29-preview
236+
POST https://{TARGET_FORM_RECOGNIZER_RESOURCE_ENDPOINT}/formrecognizer/documentModels:authorizeCopy?api-version=2024-11-30
237237
Ocp-Apim-Subscription-Key: {TARGET_FORM_RECOGNIZER_RESOURCE_KEY}
238238
```
239239

articles/ai-services/document-intelligence/prebuilt/general-document.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 11/19/2024
9+
ms.date: 02/27/2025
1010
ms.author: lajanuar
1111
---
1212

@@ -17,11 +17,11 @@ ms.author: lajanuar
1717
:::moniker range="doc-intel-4.0.0"
1818

1919
> [!IMPORTANT]
20-
> Starting with Document Intelligence versions **v4.0 preview versions** and going forward, the general document model (prebuilt-document) is deprecated. To extract key-value pairs, selection marks, text, tables, and structure from documents, use the following models:
20+
> For Document Intelligence versions **v4.0 preview versions** and going forward, the general document model (prebuilt-document) is deprecated. To extract key-value pairs, selection marks, text, tables, and structure from documents, use the following models:
2121
>
2222
>| Feature | version| Model ID |
2323
>|---------- |---------|--------|
24-
>|`Layout` model with the optional query string parameter **`features=keyValuePairs`** enabled.|&bullet; v4:2024-02-29-preview</br>&bullet; v3.1:2023-07-31 (GA) |**`prebuilt-layout`**|
24+
>|`Layout` model with the optional query string parameter **`features=keyValuePairs`** enabled.|&bullet; v4:2024-11-30</br>&bullet; v3.1:2023-07-31 (GA) |**`prebuilt-layout`**|
2525
>|General document model|&bullet; v3.1:2023-07-31 (GA)</br>&bullet; v3.0:2022-08-31 (GA)</br>&bullet; v2.1 (GA)|**`prebuilt-document`**|
2626
2727
:::moniker-end

articles/ai-services/document-intelligence/studio-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: overview
9-
ms.date: 01/15/2025
9+
ms.date: 02/27/2025
1010
ms.author: lajanuar
1111
monikerRange: '>=doc-intel-3.0.0'
1212
---
@@ -39,7 +39,7 @@ Document Intelligence Studio contains all features released on or before Novembe
3939

4040
### When to use [Azure AI Foundry portal](https://ai.azure.com/explore/aiservices/vision)
4141

42-
Start with the new Azure AI Foundry and try any of the prebuilt document models from `2024-02-29-preview` version including general extraction models like Read or Layout.
42+
Start with the new Azure AI Foundry and try any of the prebuilt document models from `2024-11-30` version including general extraction models like Read or Layout.
4343

4444
## Learn more about Document Intelligence Studio
4545

articles/ai-services/document-intelligence/train/composed-models.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 11/19/2024
9+
ms.date: 02/27/2025
1010
ms.author: lajanuar
1111
---
1212

@@ -29,7 +29,7 @@ ms.author: lajanuar
2929

3030
> [!IMPORTANT]
3131
>
32-
> The v4.0 2024-11-30 (GA) [`model compose` ](#benefits-of-the-new-model-compose-operation) operation adds an explicitly trained classifier instead of an implicit classifier for analysis. For the previous composed model version, *see* Composed custom models v3.1. If you are currently using composed models consider upgrading to the latest implementation.
32+
> The v4.0 `2024-11-30` (GA) [`model compose` ](#benefits-of-the-new-model-compose-operation) operation adds an explicitly trained classifier instead of an implicit classifier for analysis. For the previous composed model version, *see* Composed custom models v3.1. If you're currently using composed models, consider upgrading to the latest implementation.
3333
3434
## What is a composed model?
3535

@@ -119,7 +119,7 @@ Composed models are billed the same as individual custom models. The pricing is
119119

120120
### Composed model compatibility
121121

122-
|Custom model type|Models trained with v2.1 and v2.0 | Custom template and neural models v3.1 and v3.0 |Custom template and neural models v4.0 2024-11-30 (GA)|
122+
|Custom model type|Models trained with v2.1 and v2.0 | Custom template and neural models v3.1 and v3.0 |Custom template and neural models v4.0 `2024-11-30` (GA)|
123123
|--|--|--|--|
124124
|**Models trained with version 2.1 and v2.0** |Not Supported|Not Supported|Not Supported|
125125
|**Custom template and neural models v3.0 and v3.1** |Not Supported|Supported|Supported|
@@ -140,7 +140,7 @@ Document Intelligence **v4.0:2024-11-30 (GA)** supports the following tools, app
140140
| Feature | Resources |
141141
|----------|-------------|
142142
|***Custom model***| &bullet; [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>&bullet; [REST API](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)</br>&bullet; [C# SDK](../quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [Java SDK](../quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [JavaScript SDK](../quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [Python SDK](../quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|
143-
| ***Composed model***| &bullet; [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>&bullet; [REST API](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-02-29-preview&preserve-view=true)</br>&bullet; [C# SDK](/dotnet/api/azure.ai.formrecognizer.training.formtrainingclient.startcreatecomposedmodel)</br>&bullet; [Java SDK](/java/api/com.azure.ai.formrecognizer.training.formtrainingclient.begincreatecomposedmodel)</br>&bullet; [JavaScript SDK](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-latest#@azure-ai-form-recognizer-documentmodeladministrationclient-begincomposemodel&preserve-view=true)</br>&bullet; [Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)|
143+
| ***Composed model***| &bullet; [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>&bullet; [REST API](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-11-30&preserve-view=true)</br>&bullet; [C# SDK](/dotnet/api/azure.ai.formrecognizer.training.formtrainingclient.startcreatecomposedmodel)</br>&bullet; [Java SDK](/java/api/com.azure.ai.formrecognizer.training.formtrainingclient.begincreatecomposedmodel)</br>&bullet; [JavaScript SDK](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-latest#@azure-ai-form-recognizer-documentmodeladministrationclient-begincomposemodel&preserve-view=true)</br>&bullet; [Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)|
144144

145145
:::moniker-end
146146

0 commit comments

Comments
 (0)