Skip to content

Commit 0a2695c

Browse files
Merge pull request #248099 from laujan/147334-v3-1-sdk-accord
147334 v3 1 sdk ga
2 parents bb79274 + 81c5045 commit 0a2695c

9 files changed

+167
-84
lines changed

articles/ai-services/.openpublishing.redirection.ai-services-from-applied.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,17 @@
544544
"source_path_from_root": "/articles/ai-services/document-intelligence/v3-migration-guide.md",
545545
"redirect_url": "/azure/ai-services/document-intelligence/v3-1-migration-guide",
546546
"redirect_document_id": true
547+
},
548+
549+
{
550+
"source_path_from_root": "/articles/ai-services/document-intelligence/sdk-overview.md",
551+
"redirect_url": "/azure/ai-services/document-intelligence/sdk-overview-v3-0",
552+
"redirect_document_id": true
553+
},
554+
{
555+
"source_path_from_root": "/articles/ai-services/document-intelligence/sdk-preview.md",
556+
"redirect_url": "/azure/ai-services/document-intelligence/sdk-overview-v3-1",
557+
"redirect_document_id": true
547558
}
548-
549559
]
550560
}

articles/ai-services/document-intelligence/changelog-release-history.md

Lines changed: 87 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,77 @@ monikerRange: '<=doc-intel-3.1.0'
1515
<!-- markdownlint-disable MD001 -->
1616
<!-- markdownlint-disable MD033 -->
1717
<!-- markdownlint-disable MD051 -->
18+
<!-- markdownlint-disable MD024 -->
1819

19-
# Changelog and release history
20+
# SDK changelog and release history
2021

2122
This reference article provides a version-based description of Document Intelligence feature and capability releases, changes, updates, and enhancements.
2223

23-
#### Document Intelligence SDK April 2023 preview release
24+
#### August 2023 (GA) release
25+
26+
### [**C#**](#tab/csharp)
27+
28+
* **Version 4.1.0 (2023-08-10)**
29+
* **Targets API version2023-07-31 by default**
30+
* **Version 2023-02-28-preview is no longer supported**
31+
* [**Breaking changes**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md#breaking-changes-1)
32+
33+
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md)
34+
35+
[**Package (NuGet)**](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.1.0)
36+
37+
[**ReadMe**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/README.md)
38+
39+
[**Samples**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/README.md)
40+
41+
### [**Java**](#tab/java)
42+
43+
* **4.1.0 (2023-08-10)**
44+
* **Targets API version 2023-07-31 by default**
45+
* **Version 2023-02-28-preview is no longer supported**
46+
* [**Breaking changes**](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#breaking-changes)
47+
48+
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
49+
50+
[**Package (MVN)**](https://mvnrepository.com/artifact/com.azure/azure-ai-formrecognizer)
51+
52+
[**ReadMe**](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/README.md)
53+
54+
[**Samples**](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples#readme)
55+
56+
### [**JavaScript**](#tab/javascript)
57+
58+
* **Version 5.0.0 (2023-08-08)**
59+
* **Targets API version 2023-07-31 by default**
60+
* **Version 2023-02-28-preview is no longer supported**
61+
* [**Breaking changes**](https://github.com/witemple-msft/azure-sdk-for-js/blob/ai-form-recognizer/5.0.0-release/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md#breaking-changes)
62+
63+
[**Changelog/Release History**](https://github.com/witemple-msft/azure-sdk-for-js/blob/ai-form-recognizer/5.0.0-release/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md)
64+
65+
[**Package (npm)**](https://www.npmjs.com/package/@azure/ai-form-recognizer)
66+
67+
[**ReadMe**](https://github.com/witemple-msft/azure-sdk-for-js/blob/ai-form-recognizer/5.0.0-release/sdk/formrecognizer/ai-form-recognizer/README.md)
68+
69+
[**Samples**](https://github.com/witemple-msft/azure-sdk-for-js/tree/ai-form-recognizer/5.0.0-release/sdk/formrecognizer/ai-form-recognizer/samples/v5)
70+
71+
### [**Python**](#tab/python)
72+
73+
* **Version 3.3.0 (2023-08-08)**
74+
* **Targets API version 2023-07-31 by default**
75+
* **Version 2023-02-28-preview is no longer supported**
76+
* [**Breaking changes**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.3.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#breaking-changes)
77+
78+
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.3.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
79+
80+
[**Package (PyPi)**](https://pypi.org/project/azure-ai-formrecognizer/3.3.0/)
81+
82+
[**ReadMe**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.3.0/sdk/formrecognizer/azure-ai-formrecognizer/README.md)
83+
84+
[**Samples**](https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-formrecognizer_3.3.0/sdk/formrecognizer/azure-ai-formrecognizer/samples)
85+
86+
---
87+
88+
#### April 2023 (preview) release
2489

2590
This release includes the following updates:
2691

@@ -30,10 +95,10 @@ This release includes the following updates:
3095
* **Targets 2023-02-28-preview by default**
3196
* **No breaking changes**
3297

33-
[**Package (NuGet)**](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.1.0-beta.1)
34-
3598
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md#410-beta1-2023-04-13)
3699

100+
[**Package (NuGet)**](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.1.0-beta.1)
101+
37102
[**ReadMe**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/README.md)
38103

39104
[**Samples**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/README.md)
@@ -44,10 +109,11 @@ This release includes the following updates:
44109
* **Targets 2023-02-28-preview by default**
45110
* **No breaking changes**
46111

47-
[**Package (MVN)**](https://mvnrepository.com/artifact/com.azure/azure-ai-formrecognizer/4.1.0-beta.1)
48112

49113
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.1.0-beta.1/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#410-beta1-2023-04-12)
50114

115+
[**Package (MVN)**](https://mvnrepository.com/artifact/com.azure/azure-ai-formrecognizer/4.1.0-beta.1)
116+
51117
[**ReadMe**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.1.0-beta.1/sdk/formrecognizer/azure-ai-formrecognizer/README.md)
52118

53119
[**Samples**](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples#readme)
@@ -58,10 +124,10 @@ This release includes the following updates:
58124
* **Targets 2023-02-28-preview by default**
59125
* **No breaking changes**
60126

61-
[**Package (npm)**](https://www.npmjs.com/package/@azure/ai-form-recognizer/v/4.1.0-beta.1)
62-
63127
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-js/blob/a162daee4be05eadff0be1caa7fb2071960bbf44/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md#410-beta1-2023-04-11)
64128

129+
[**Package (npm)**](https://www.npmjs.com/package/@azure/ai-form-recognizer/v/4.1.0-beta.1)
130+
65131
[**ReadMe**](https://github.com/Azure/azure-sdk-for-js/blob/a162daee4be05eadff0be1caa7fb2071960bbf44/sdk/formrecognizer/ai-form-recognizer/README.md)
66132

67133
[**Samples**](https://github.com/Azure/azure-sdk-for-js/tree/a162daee4be05eadff0be1caa7fb2071960bbf44/sdk/formrecognizer/ai-form-recognizer/samples/v4-beta)
@@ -72,17 +138,17 @@ This release includes the following updates:
72138
* **Targets 2023-02-28-preview by default**
73139
* **No breaking changes**
74140

75-
[**Package (PyPi)**](https://pypi.org/project/azure-ai-formrecognizer/3.3.0b1/)
76-
77141
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.3.0b1/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#330b1-2023-04-13)
78142

143+
[**Package (PyPi)**](https://pypi.org/project/azure-ai-formrecognizer/3.3.0b1/)
144+
79145
[**ReadMe**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.3.0b1/sdk/formrecognizer/azure-ai-formrecognizer/README.md)
80146

81147
[**Samples**](https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-formrecognizer_3.3.0b1/sdk/formrecognizer/azure-ai-formrecognizer/samples)
82148

83149
---
84150

85-
#### Document Intelligence SDK September 2022 (GA) release
151+
#### September 2022 (GA) release
86152

87153
This release includes the following updates:
88154

@@ -94,10 +160,10 @@ This release includes the following updates:
94160
* **Version 4.0.0 GA (2022-09-08)**
95161
* **Supports REST API v3.0 and v2.0 clients**
96162

97-
[**Package (NuGet)**](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.0.0)
98-
99163
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md)
100164

165+
[**Package (NuGet)**](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.0.0)
166+
101167
[**Migration guide**](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.FormRecognizer_4.0.0/sdk/formrecognizer/Azure.AI.FormRecognizer/MigrationGuide.md)
102168

103169
[**ReadMe**](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.FormRecognizer_4.0.0/sdk/formrecognizer/Azure.AI.FormRecognizer/README.md)
@@ -109,10 +175,10 @@ This release includes the following updates:
109175
* **Version 4.0.0 GA (2022-09-08)**
110176
* **Supports REST API v3.0 and v2.0 clients**
111177

112-
[**Package (Maven)**](https://oss.sonatype.org/#nexus-search;quick~azure-ai-formrecognizer)
113-
114178
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.0.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
115179

180+
[**Package (Maven)**](https://oss.sonatype.org/#nexus-search;quick~azure-ai-formrecognizer)
181+
116182
[**Migration guide**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.0.0/sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md)
117183

118184
[**ReadMe**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.0.0/sdk/formrecognizer/azure-ai-formrecognizer/README.md)
@@ -124,10 +190,10 @@ This release includes the following updates:
124190
* **Version 4.0.0 GA (2022-09-08)**
125191
* **Supports REST API v3.0 and v2.0 clients**
126192

127-
[**Package (npm)**](https://www.npmjs.com/package/@azure/ai-form-recognizer)
128-
129193
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-js/blob/%40azure/ai-form-recognizer_4.0.0/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md)
130194

195+
[**Package (npm)**](https://www.npmjs.com/package/@azure/ai-form-recognizer)
196+
131197
[**Migration guide**](https://github.com/Azure/azure-sdk-for-js/blob/%40azure/ai-form-recognizer_4.0.0/sdk/formrecognizer/ai-form-recognizer/MIGRATION-v3_v4.md)
132198

133199
[**ReadMe**](https://github.com/Azure/azure-sdk-for-js/blob/%40azure/ai-form-recognizer_4.0.0/sdk/formrecognizer/ai-form-recognizer/README.md)
@@ -142,10 +208,10 @@ This release includes the following updates:
142208
* **Version 3.2.0 GA (2022-09-08)**
143209
* **Supports REST API v3.0 and v2.0 clients**
144210

145-
[**Package (PyPi)**](https://pypi.org/project/azure-ai-formrecognizer/3.2.0/)
146-
147211
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
148212

213+
[**Package (PyPi)**](https://pypi.org/project/azure-ai-formrecognizer/3.2.0/)
214+
149215
[**Migration guide**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0/sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md)
150216

151217
[**ReadMe**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0/sdk/formrecognizer/azure-ai-formrecognizer/README.md)
@@ -154,11 +220,7 @@ This release includes the following updates:
154220

155221
---
156222

157-
158-
159-
160-
161-
#### Document Intelligence SDK beta August 2022 preview release
223+
#### August 2022 (preview) release
162224

163225
This release includes the following updates:
164226

@@ -211,11 +273,7 @@ This release includes the following updates:
211273

212274
---
213275

214-
215-
216-
217-
218-
### Document Intelligence SDK beta June 2022 preview release
276+
### June 2022 (preview) release
219277

220278
This release includes the following updates:
221279

@@ -259,8 +317,4 @@ This release includes the following updates:
259317

260318
[**SDK reference documentation**](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer?view=azure-python-preview&preserve-view=true)
261319

262-
---
263-
264-
265-
266-
320+
---

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The task of recognizing small text from large-size documents, like engineering d
3939

4040
## Barcode extraction
4141

42-
The Read OCR model extracts all identified barcodes in the `barcodes` collection as a top level object under `content`. Inside the `content`, detected barcodes are represented as `:barcode:`. Each entry in this collection represents a barcode and includes the barcode type as `kind` and the embedded barcode content as `value` along with its `polygon` coordinates. Initially, barcodes appear at the end of each page. Here, the `confidence` is hard-coded for the public preview (`2023-02-28`) release.
42+
The Read OCR model extracts all identified barcodes in the `barcodes` collection as a top level object under `content`. Inside the `content`, detected barcodes are represented as `:barcode:`. Each entry in this collection represents a barcode and includes the barcode type as `kind` and the embedded barcode content as `value` along with its `polygon` coordinates. Initially, barcodes appear at the end of each page. Here, the `confidence` is hard-coded for the API (GA) version (`2023-07-31`).
4343

4444
### Supported barcode types
4545

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Custom classification models require a minimum of five samples per class to trai
5959

6060
## Training a model
6161

62-
Custom classification models are only available in the [v3.1 API](v3-1-migration-guide.md) starting with API version ```2023-02-28-preview```. [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio) provides a no-code user interface to interactively train a custom classifier.
62+
Custom classification models are only available in the [v3.1 API](v3-1-migration-guide.md) version ```2023-07-31```. [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio) provides a no-code user interface to interactively train a custom classifier.
6363

6464
When using the REST API, if you've organized your documents by folders, you can use the ```azureBlobSource``` property of the request to train a classification model.
6565

articles/ai-services/document-intelligence/index.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### YamlMime:Landing
22

33
title: Azure AI Document Intelligence documentation # < 60 chars
4-
summary: Azure AI Document Intelligence (formerly Form Recognizer) is a cloud-based Azure AI service that uses machine-learning models to extract key-value pairs, text, and tables from your documents.\n Document Intelligence analyzes your forms and documents, extracts text and data, maps field relationships as key-value pairs, and returns a structured JSON output.\n You quickly get accurate results that are tailored to your specific content without excessive manual intervention or extensive data science expertise.\n Use Document Intelligence to automate your data processing in applications and workflows, enhance data-driven strategies, and enrich document search capabilities. # < 160 chars
4+
summary: Azure AI Document Intelligence (formerly Form Recognizer) is a cloud-based Azure AI service that uses machine-learning models to automate your data processing in applications and workflows. Document Intelligence is essential for enhancing data-driven strategies and enriching document search capabilities. # < 160 chars
55

66
metadata:
77
title: Document Intelligence documentation - Quickstarts, Tutorials, API Reference - Azure AI services | Microsoft Docs
@@ -36,7 +36,7 @@ landingContent:
3636
- text: Language support
3737
url: language-support.md
3838
- text: 🆕 SDK overview
39-
url: sdk-preview.md
39+
url: sdk-overview-v3-1.md
4040
- text: SDK overview (GA)
4141
url: sdk-overview.md
4242
- text: Help and support

0 commit comments

Comments
 (0)