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: sdk/documentintelligence/Azure.AI.DocumentIntelligence/CHANGELOG.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Release History
2
2
3
-
## 1.0.0-beta.4 (Unreleased)
3
+
## 1.0.0 (2024-12-17)
4
4
5
5
### Features Added
6
6
- Added methods `GetAnalyzeBatchResult`, `GetAnalyzeBatchResults`, `DeleteAnalyzeBatchResult`, and `DeleteAnalyzeResult` to `DocumentIntelligenceClient`.
@@ -58,8 +58,6 @@
58
58
- Fixed a bug where calling `Operation.Id` would sometimes return an `InvalidOperationException` with message "The operation ID was not present in the service response.".
59
59
- Calling `Operation.Id` in an operation returned from the `AnalyzeBatchDocuments` and `ClassifyDocument` APIs won't throw a `NotSupportedException` anymore.
Copy file name to clipboardExpand all lines: sdk/documentintelligence/Azure.AI.DocumentIntelligence/MigrationGuide.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Guide for migrating to Azure.AI.DocumentIntelligence from Azure.AI.FormRecognizer
2
2
3
-
This guide is intended to assist in the migration to `Azure.AI.DocumentIntelligence (1.0.0-beta.3)` from `Azure.AI.FormRecognizer (4.1.0 or 4.0.0)`. It will focus on side-by-side comparisons for similar operations between libraries. Please note that version `1.0.0-beta.3` will be used for comparison with `4.1.0`.
3
+
This guide is intended to assist in the migration to `Azure.AI.DocumentIntelligence (1.0.0)` from `Azure.AI.FormRecognizer (4.1.0 or 4.0.0)`. It will focus on side-by-side comparisons for similar operations between libraries. Please note that version `1.0.0` will be used for comparison with `4.1.0`.
4
4
5
5
Familiarity with the `Azure.AI.FormRecognizer` package is assumed. For those new to the Document Intelligence and the Form Recognizer client libraries for .NET, please refer to the [README][readme] rather than this guide. For an exhaustive list of breaking changes between the packages, see the [CHANGELOG][changelog].
6
6
@@ -22,7 +22,7 @@ Familiarity with the `Azure.AI.FormRecognizer` package is assumed. For those new
22
22
23
23
A natural question to ask when considering whether to adopt a new version of a library is what the benefits of doing so would be. As Azure Document Intelligence has matured and been embraced by a more diverse group of developers, we have been focused on learning the patterns and practices to best support developer productivity and add value to our customers.
24
24
25
-
There are many benefits to using the new `Azure.AI.DocumentIntelligence` library. This new library introduces two new clients: `DocumentIntelligenceClient` and `DocumentIntelligenceAdministrationClient`, providing support for the new features added by the service in API version `2024-07-31-preview` and higher.
25
+
There are many benefits to using the new `Azure.AI.DocumentIntelligence` library. This new library introduces two new clients: `DocumentIntelligenceClient` and `DocumentIntelligenceAdministrationClient`, providing support for the new features added by the service in API version `2024-11-30` and higher.
26
26
27
27
New features provided by the `Azure.AI.DocumentIntelligence` library include:
28
28
-**Markdown content format:** support to output with Markdown content format along with the default plain text. This is only supported for the "prebuilt-layout" model. Markdown content format is deemed a more friendly format for LLM consumption in a chat or automation use scenario.
@@ -36,7 +36,7 @@ The table below describes the relationship of each client and its supported API
36
36
37
37
Package|API version|Supported clients
38
38
|-|-|-
39
-
|Azure.AI.DocumentIntelligence | 2024-07-31-preview | DocumentIntelligenceClient and DocumentIntelligenceAdministrationClient
39
+
|Azure.AI.DocumentIntelligence | 2024-11-30 | DocumentIntelligenceClient and DocumentIntelligenceAdministrationClient
40
40
|Azure.AI.FormRecognizer |2023-07-31 | DocumentAnalysisClient and DocumentModelAdministrationClient
41
41
|Azure.AI.FormRecognizer |2022-08-31 | DocumentAnalysisClient and DocumentModelAdministrationClient
42
42
|Azure.AI.FormRecognizer |2.1 | FormRecognizerClient and FormTrainingClient
@@ -59,7 +59,7 @@ Some terminology has changed to reflect the enhanced capabilities of the latest
59
59
60
60
We continue to support API key and AAD authentication methods when creating the clients. Below are the differences between the two versions:
61
61
62
-
- In `Azure.AI.DocumentIntelligence`, we have `DocumentIntelligenceClient` and `DocumentIntelligenceAdministrationClient` which support API version `2024-07-31-preview` and higher.
62
+
- In `Azure.AI.DocumentIntelligence`, we have `DocumentIntelligenceClient` and `DocumentIntelligenceAdministrationClient` which support API version `2024-11-30` and higher.
63
63
- Some client methods have been renamed. See the [CHANGELOG][changelog] for an exhaustive list of changes.
64
64
65
65
Creating new clients in `Azure.AI.FormRecognizer`:
@@ -83,7 +83,7 @@ var documentIntelligenceAdministrationClient = new DocumentIntelligenceAdministr
83
83
### Analyzing documents
84
84
85
85
Differences between the versions:
86
-
- The former `AnalyzeDocument` method taking a `Stream` as the input document is still not supported in `Azure.AI.DocumentIntelligence` 1.0.0-beta.3. As a workaround you will need to use a URI input or the new Base64 input option, which is described later in this guide ([Analyzing and classifying documents from a stream](#analyzing-and-classifying-documents-from-a-stream)).
86
+
- The former `AnalyzeDocument` method taking a `Stream` as the input document is still not supported in `Azure.AI.DocumentIntelligence` 1.0.0. As a workaround you will need to use a URI input or the new Base64 input option, which is described later in this guide ([Analyzing and classifying documents from a stream](#analyzing-and-classifying-documents-from-a-stream)).
87
87
-`AnalyzeDocumentFromUri` has been renamed to `AnalyzeDocument` and its input arguments have been reorganized:
88
88
- The `documentUri` parameter has been removed. Instead, an `AnalyzeDocumentContent` object must be passed to the method to select the desired input type: URI or Base64 binary data.
89
89
- The `options` parameter has been removed. Instead, `pages`, `locale`, and `features` options can be passed directly as method parameters.
@@ -298,7 +298,7 @@ for (int i = 0; i < result.Documents.Count; i++)
298
298
### Classifying documents
299
299
300
300
Differences between the versions:
301
-
- The former `ClassifyDocument` method taking a `Stream` as the input document is still not supported in `Azure.AI.DocumentIntelligence` 1.0.0-beta.3. As a workaround you will need to use a URI input or the new Base64 input option, which is described later in this guide ([Analyzing and classifying documents from a stream](#analyzing-and-classifying-documents-from-a-stream)).
301
+
- The former `ClassifyDocument` method taking a `Stream` as the input document is still not supported in `Azure.AI.DocumentIntelligence` 1.0.0. As a workaround you will need to use a URI input or the new Base64 input option, which is described later in this guide ([Analyzing and classifying documents from a stream](#analyzing-and-classifying-documents-from-a-stream)).
302
302
-`ClassifyDocumentFromUri` has been renamed to `ClassifyDocument` and its input arguments have been reorganized. The `documentUri` parameter has been removed. Instead, a `ClassifyDocumentContent` object must be passed to the method to select the desired input type: URI or Base64 binary data.
303
303
304
304
Classifying documents with `Azure.AI.FormRecognizer`:
@@ -546,7 +546,7 @@ foreach (DocumentLine line in firstPage.Lines)
546
546
547
547
### Accessing an existing long-running operation
548
548
549
-
Storing the ID of a long-running operation to retrieve its status at a later point in time is still not supported in `Azure.AI.DocumentIntelligence` 1.0.0-beta.3. There are no straightforward workarounds to support this scenario.
549
+
Storing the ID of a long-running operation to retrieve its status at a later point in time is still not supported in `Azure.AI.DocumentIntelligence` 1.0.0. There are no straightforward workarounds to support this scenario.
0 commit comments