Skip to content

Commit 4fc37de

Browse files
authored
[DocumentIntelligence] Updating version in docs (Azure#47497)
1 parent a00de4b commit 4fc37de

File tree

4 files changed

+11
-13
lines changed

4 files changed

+11
-13
lines changed

sdk/documentintelligence/Azure.AI.DocumentIntelligence/CHANGELOG.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release History
22

3-
## 1.0.0-beta.4 (Unreleased)
3+
## 1.0.0 (2024-12-17)
44

55
### Features Added
66
- Added methods `GetAnalyzeBatchResult`, `GetAnalyzeBatchResults`, `DeleteAnalyzeBatchResult`, and `DeleteAnalyzeResult` to `DocumentIntelligenceClient`.
@@ -58,8 +58,6 @@
5858
- Fixed a bug where calling `Operation.Id` would sometimes return an `InvalidOperationException` with message "The operation ID was not present in the service response.".
5959
- Calling `Operation.Id` in an operation returned from the `AnalyzeBatchDocuments` and `ClassifyDocument` APIs won't throw a `NotSupportedException` anymore.
6060

61-
### Other Changes
62-
6361
## 1.0.0-beta.3 (2024-08-14)
6462

6563
### Features Added

sdk/documentintelligence/Azure.AI.DocumentIntelligence/MigrationGuide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Guide for migrating to Azure.AI.DocumentIntelligence from Azure.AI.FormRecognizer
22

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`.
44

55
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].
66

@@ -22,7 +22,7 @@ Familiarity with the `Azure.AI.FormRecognizer` package is assumed. For those new
2222

2323
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.
2424

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.
2626

2727
New features provided by the `Azure.AI.DocumentIntelligence` library include:
2828
- **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
3636

3737
Package|API version|Supported clients
3838
|-|-|-
39-
|Azure.AI.DocumentIntelligence | 2024-07-31-preview | DocumentIntelligenceClient and DocumentIntelligenceAdministrationClient
39+
|Azure.AI.DocumentIntelligence | 2024-11-30 | DocumentIntelligenceClient and DocumentIntelligenceAdministrationClient
4040
|Azure.AI.FormRecognizer |2023-07-31 | DocumentAnalysisClient and DocumentModelAdministrationClient
4141
|Azure.AI.FormRecognizer |2022-08-31 | DocumentAnalysisClient and DocumentModelAdministrationClient
4242
|Azure.AI.FormRecognizer |2.1 | FormRecognizerClient and FormTrainingClient
@@ -59,7 +59,7 @@ Some terminology has changed to reflect the enhanced capabilities of the latest
5959

6060
We continue to support API key and AAD authentication methods when creating the clients. Below are the differences between the two versions:
6161

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.
6363
- Some client methods have been renamed. See the [CHANGELOG][changelog] for an exhaustive list of changes.
6464

6565
Creating new clients in `Azure.AI.FormRecognizer`:
@@ -83,7 +83,7 @@ var documentIntelligenceAdministrationClient = new DocumentIntelligenceAdministr
8383
### Analyzing documents
8484

8585
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)).
8787
- `AnalyzeDocumentFromUri` has been renamed to `AnalyzeDocument` and its input arguments have been reorganized:
8888
- 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.
8989
- 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++)
298298
### Classifying documents
299299

300300
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)).
302302
- `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.
303303

304304
Classifying documents with `Azure.AI.FormRecognizer`:
@@ -546,7 +546,7 @@ foreach (DocumentLine line in firstPage.Lines)
546546

547547
### Accessing an existing long-running operation
548548

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.
550550

551551
## Additional samples
552552

sdk/documentintelligence/Azure.AI.DocumentIntelligence/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ This section should include everything a developer needs to do to install and cr
2121
Install the Azure Document Intelligence client library for .NET with [NuGet][nuget]:
2222

2323
```dotnetcli
24-
dotnet add package Azure.AI.DocumentIntelligence --prerelease
24+
dotnet add package Azure.AI.DocumentIntelligence
2525
```
2626

27-
> Note: This version of the client library defaults to the `2024-07-31-preview` version of the service.
27+
> Note: This version of the client library defaults to the `2024-11-30` version of the service.
2828
2929
### Prerequisites
3030

sdk/documentintelligence/Azure.AI.DocumentIntelligence/src/Azure.AI.DocumentIntelligence.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<PropertyGroup>
33
<Description>This is the Azure.AI.DocumentIntelligence client library for developing .NET applications with rich experience.</Description>
44
<AssemblyTitle>Azure SDK Code Generation Azure.AI.DocumentIntelligence for Azure Data Plane</AssemblyTitle>
5-
<Version>1.0.0-beta.4</Version>
5+
<Version>1.0.0</Version>
66
<PackageTags>Microsoft Azure Document Intelligence Cognitive Services Applied AI Form Recognizer</PackageTags>
77
<TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
88
<IncludeOperationsSharedSource>true</IncludeOperationsSharedSource>

0 commit comments

Comments
 (0)