Skip to content

Commit e5b5f81

Browse files
author
Jill Grant
authored
Merge pull request #2047 from laujan/344898-v4-ga-sdks
update sdks
2 parents 009712d + 1011842 commit e5b5f81

File tree

7 files changed

+93
-21
lines changed

7 files changed

+93
-21
lines changed

articles/ai-services/document-intelligence/quickstarts/get-started-sdks-rest-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.custom:
1111
- devx-track-js
1212
- devx-track-python
1313
ms.topic: quickstart
14-
ms.date: 11/19/2024
14+
ms.date: 12/17/2024
1515
ms.author: lajanuar
1616
zone_pivot_groups: programming-languages-set-formre
1717
---
@@ -29,7 +29,7 @@ zone_pivot_groups: programming-languages-set-formre
2929

3030
**This content applies to:** ![checkmark](../media/yes-icon.png) **v4.0 (GA)** **Earlier versions:** ![blue-checkmark](../media/blue-yes-icon.png) [v3.1 (GA)](?view=doc-intel-3.1.0&preserve-view=true) ![blue-checkmark](../media/blue-yes-icon.png) [v3.0 (GA)](?view=doc-intel-3.0.0&preserve-view=true)
3131

32-
* Get started with Azure AI Document Intelligence latest stable version v4.0 2024-11-30 (GA).
32+
* Get started with Azure AI Document Intelligence latest stable version v4.0 `2024-11-30` (GA).
3333

3434
:::moniker-end
3535

@@ -53,7 +53,7 @@ zone_pivot_groups: programming-languages-set-formre
5353

5454
* You can easily integrate document processing models into your workflows and applications by using a programming language SDK or calling the REST API.
5555

56-
* For this quickstart, we recommend that you use the free service while you're learning the technology. Remember that the number of free pages is limited to 500 per month.
56+
* We recommend that you use the free service while you're learning the technology for this quickstart. Remember that the number of free pages is limited to 500 per month.
5757

5858
To learn more about the API features and development options, visit our [Overview](../overview.md) page.
5959

articles/ai-services/document-intelligence/quickstarts/includes/csharp-sdk.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: "Quickstart: Document Intelligence C# SDK | v4.0 | v3.1 | v3.0"
2+
title: "Quickstart: Document Intelligence C# SDK"
33
titleSuffix: Azure AI services
44
description: 'Form and document processing, data extraction, and analysis using Document Intelligence C# client library.'
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: include
9-
ms.date: 11/19/2024
9+
ms.date: 12/17/2024
1010
ms.author: lajanuar
1111
monikerRange: ">=doc-intel-3.0.0"
1212
---
@@ -16,7 +16,7 @@ monikerRange: ">=doc-intel-3.0.0"
1616
<!-- markdownlint-disable MD029 -->
1717

1818
:::moniker range="doc-intel-4.0.0"
19-
[Client library](/dotnet/api/overview/azure/ai.documentintelligence-readme?view=azure-dotnet-preview&preserve-view=true) | [SDK reference](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.DocumentIntelligence/1.0.0-beta.3/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Package](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0-beta.3)| [Samples]( https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/README.md)|[Supported REST API version](../../sdk-overview-v4-0.md)
19+
[Client library](/dotnet/api/overview/azure/cognitiveservices/documentintelligence?view=azure-dotnet&preserve-view=true) | [SDK reference](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.DocumentIntelligence/1.0.0/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Package](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0)| [Samples](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/README.md)|[Supported REST API version](../../sdk-overview-v4-0.md)
2020
:::moniker-end
2121

2222
:::moniker range="doc-intel-3.1.0"
@@ -164,7 +164,7 @@ To interact with the Form Recognizer service, you need to create an instance of
164164
165165
1. Open the **Program.cs** file.
166166

167-
1. Delete the pre-existing code, including the line `Console.Writeline("Hello World!")`, and select one of the following code samples to copy and paste into your application's Program.cs file:
167+
1. Delete the existing code, including the line `Console.Writeline("Hello World!")`, and select one of the following code samples to copy and paste into your application's Program.cs file:
168168

169169
* [**Layout model**](#layout-model)
170170

articles/ai-services/document-intelligence/quickstarts/includes/java-sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: "Quickstart: Document Intelligence Java SDK (beta) | v3.1 | v3.0"
2+
title: "Quickstart: Document Intelligence Java SDK"
33
titleSuffix: Azure AI services
44
description: Form and document processing, data extraction, and analysis using Document Intelligence Java client library.
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: include
9-
ms.date: 11/19/2024
9+
ms.date: 12/17/2024
1010
ms.author: lajanuar
1111
---
1212
<!-- markdownlint-disable MD025 -->
1313
<!-- markdownlint-disable MD036 -->
1414

1515
:::moniker range="doc-intel-4.0.0"
16-
[Client library](/java/api/overview/azure/ai-documentintelligence-readme?view=azure-java-preview&preserve-view=true) | [SDK reference](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-documentintelligence/1.0.0-beta.4/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Package (Maven)](https://mvnrepository.com/artifact/com.azure/azure-ai-documentintelligence/1.0.0-beta.4) | [Samples](https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.4/sdk/documentintelligence/azure-ai-documentintelligence/src/samples) |[Supported REST API version](../../sdk-overview-v4-0.md)
16+
[Client library](/java/api/overview/azure/ai-documentintelligence-readme?view=azure-java-preview&preserve-view=true) | [SDK reference](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-documentintelligence/1.0.0/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Package (Maven)](https://mvnrepository.com/artifact/com.azure/azure-ai-documentintelligence/1.0.0-beta.4) | [Samples](https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#examples) |[Supported REST API version](../../sdk-overview-v4-0.md)
1717
:::moniker-end
1818

1919
:::moniker range="doc-intel-3.1.0"

articles/ai-services/document-intelligence/quickstarts/includes/javascript-sdk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: include
9-
ms.date: 11/19/2024
9+
ms.date: 12/17/2024
1010
ms.author: lajanuar
1111
---
1212
<!-- markdownlint-disable MD025 -->
1313

1414
:::moniker range="doc-intel-4.0.0"
15-
[Client library](/javascript/api/overview/azure/ai-document-intelligence-rest-readme?view=azure-node-preview&preserve-view=true) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Package (npm)](https://www.npmjs.com/package/@azure-rest/ai-document-intelligence/v/1.0.0-beta.3) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples/v1-beta) |[Supported REST API version](../../sdk-overview-v4-0.md)
15+
[Client library](/javascript/api/overview/azure/ai-document-intelligence-rest-readme?view=azure-node-preview&preserve-view=true) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Package (npm)]( https://www.npmjs.com/package/@azure-rest/ai-document-intelligence/v/1.0.0) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples/v1-beta) |[Supported REST API version](../../sdk-overview-v4-0.md)
1616
:::moniker-end
1717

1818
:::moniker range="doc-intel-3.1.0"

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

Lines changed: 62 additions & 1 deletion
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: reference
9-
ms.date: 11/19/2024
9+
ms.date: 12/17/2024
1010
ms.author: lajanuar
1111
---
1212

@@ -19,6 +19,67 @@ ms.author: lajanuar
1919

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

22+
#### December 2024 (GA) release
23+
24+
25+
### [**.NET (C#)**](#tab/csharp)
26+
27+
* Document Intelligence **1.0.0**
28+
* **Targets REST API 2024-11-30 (GA) by default**
29+
30+
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/CHANGELOG.md#100-2024-12-16)
31+
32+
[**Package (NuGet)**](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0)
33+
34+
[**Azure SDK**](/dotnet/api/overview/azure/cognitiveservices/documentintelligence?view=azure-dotnet&preserve-view=true)
35+
36+
[**ReadMe**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/README.md)
37+
38+
39+
[**Samples**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/README.md)
40+
41+
[**Migration guide**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/MigrationGuide.md)
42+
43+
### [**Java**](#tab/java)
44+
45+
* Document Intelligence **1.0.0**
46+
* **Targets REST API 2024-11-30 (GA) by default**
47+
48+
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0/sdk/documentintelligence/azure-ai-documentintelligence/CHANGELOG.md#100-2024-12-16)
49+
50+
[**Package Maven**](https://central.sonatype.com/artifact/com.azure/azure-ai-documentintelligence/1.0.0)
51+
52+
[**ReadMe**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0/sdk/documentintelligence/azure-ai-documentintelligence/README.md)
53+
54+
[**Samples**](https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#examples)
55+
56+
[**Migration guide**](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/documentintelligence/azure-ai-documentintelligence/MIGRATION_GUIDE.md)
57+
58+
### [**JavaScript**](#tab/javascript)
59+
60+
* Document Intelligence **1.0.0**
61+
* **Targets REST API 2024-11-30 (GA) by default**
62+
63+
[**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md#100-2024-12-16)
64+
65+
[**Package (npm)**](https://www.npmjs.com/package/@azure-rest/ai-document-intelligence/v/1.0.0)
66+
67+
[**ReadMe**](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest#azure-documentintelligence-formerly-formrecognizer-rest-client-library-for-javascript)
68+
69+
[**Samples**](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples/v1)
70+
71+
[**Migration guide**](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documentintelligence/ai-document-intelligence-rest/MIGRATION-FR_v4-DI_v1.md)
72+
73+
### [**Python**](#tab/python)
74+
75+
* Document Intelligence **1.0.0**
76+
* **Targets REST API 2024-11-30 (GA) by default**
77+
78+
[**Migration guide**](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/documentintelligence/azure-ai-documentintelligence/MIGRATION_GUIDE.md)
79+
80+
---
81+
82+
2283
#### August 2024 (preview) release
2384

2485
### [**.NET (C#)**](#tab/csharp)

articles/ai-services/document-intelligence/versioning/sdk-overview-v4-0.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.custom:
1111
- devx-track-js
1212
- devx-track-python
1313
ms.topic: conceptual
14-
ms.date: 11/19/2024
14+
ms.date: 12/17/2024
1515
ms.author: lajanuar
1616
monikerRange: 'doc-intel-4.0.0'
1717
---
@@ -22,7 +22,7 @@ monikerRange: 'doc-intel-4.0.0'
2222
<!-- markdownlint-disable MD001 -->
2323
<!-- markdownlint-disable MD051 -->
2424

25-
# SDK target: REST API v4.0
25+
# SDK target: REST API v4.0 (GA)
2626

2727
![Document Intelligence checkmark](../media/yes-icon.png) **REST API version 2024-11-30 GA**
2828

@@ -34,9 +34,9 @@ Document Intelligence SDK supports the following languages and platforms:
3434

3535
| Language → Document Intelligence SDK version &emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;| Package| Supported API version &emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;| Platform support |
3636
|:----------------------:|:----------|:----------| :----------------:|
37-
| [**.NET/C# → 1.0.0-beta.3 (preview)**](/dotnet/api/overview/azure/ai.documentintelligence-readme?view=azure-dotnet-preview&preserve-view=true)|[NuGet](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0-beta.3)|[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)|[Windows, macOS, Linux, Docker](https://dotnet.microsoft.com/download)|
38-
|[**Java → 1.0.0-beta.4 (preview)**](/java/api/overview/azure/ai-documentintelligence-readme?view=azure-java-preview&preserve-view=true) |[Maven repository](https://mvnrepository.com/artifact/com.azure/azure-ai-documentintelligence/1.0.0-beta.4) |[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)|[Windows, macOS, Linux](/java/openjdk/install)|
39-
|[**JavaScript → 1.0.0-beta.3 (preview)**](/javascript/api/overview/azure/ai-document-intelligence-rest-readme?view=azure-node-preview&preserve-view=true)| [npm](https://www.npmjs.com/package/@azure-rest/ai-document-intelligence/v/1.0.0-beta.3)|[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)| [Browser, Windows, macOS, Linux](https://nodejs.org/en/download/) |
37+
| [**.NET/C# → 1.0.0 (GA)**](/dotnet/api/overview/azure/cognitiveservices/documentintelligence?view=azure-dotnet&preserve-view=true)|[NuGet](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0)|[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)|[Windows, macOS, Linux, Docker](https://dotnet.microsoft.com/download)|
38+
|[**Java → 1.0.0 (GA**](/java/api/overview/azure/ai-documentintelligence-readme?view=azure-java-preview&preserve-view=true) |[Maven repository](https://central.sonatype.com/artifact/com.azure/azure-ai-documentintelligence/1.0.0) |[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)|[Windows, macOS, Linux](/java/openjdk/install)|
39+
|[**JavaScript → 1.0.0 (GA)**](/javascript/api/overview/azure/ai-document-intelligence-rest-readme?view=azure-node-preview&preserve-view=true)| [npm](https://www.npmjs.com/package/@azure-rest/ai-document-intelligence/v/1.0.0)|[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)| [Browser, Windows, macOS, Linux](https://nodejs.org/en/download/) |
4040
|[**Python → 1.0.0b4 (preview)**](/python/api/overview/azure/ai-documentintelligence-readme?view=azure-python-preview&preserve-view=true) | [PyPI](https://pypi.org/project/azure-ai-documentintelligence/1.0.0b4/)|[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)|[Windows, macOS, Linux](/azure/developer/python/configure-local-development-environment?tabs=windows%2Capt%2Ccmd#use-the-azure-cli)|
4141

4242
For more information on other SDK versions, see:

articles/ai-services/document-intelligence/whats-new.md

Lines changed: 14 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: whats-new
9-
ms.date: 11/19/2024
9+
ms.date: 12/17/2024
1010
ms.author: lajanuar
1111
ms.custom:
1212
- references_regions
@@ -25,11 +25,22 @@ ms.custom:
2525
Document Intelligence service is updated on an ongoing basis. Bookmark this page to stay up to date with release notes, feature enhancements, and our newest documentation.
2626

2727
> [!IMPORTANT]
28-
> Preview API versions are retired once the GA API is released. The 2023-02-28-preview API version is being retired, if you are still using the preview API or the associated SDK versions, please update your code to target the latest API version 2023-07-31 (GA). </br>
28+
> Preview API versions are retired once the GA API is released. The 2023-02-28-preview API version is being retired, if you are still using the preview API or the associated SDK versions, please update your code to target the latest API version 2024-11-30 (GA). </br>
29+
30+
## December 2024
31+
32+
**Document Intelligence v4.0 programming language client library SDKs are now generally available (GA)**! <br><br>The v4.0 (GA) client libraries default to the [**2024-11-30 REST API (GA)**](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) version of the service.
33+
For more information, *see* client libraries for the following supported programming languages:
34+
35+
* [🆕 .NET (C#)](versioning/changelog-release-history.md?view=doc-intel-4.0.0&tabs=csharp&preserve-view=true)
36+
37+
* [🆕 Java](versioning/changelog-release-history.md?view=doc-intel-4.0.0&tabs=java&preserve-view=true)
38+
39+
* [🆕 JavaScript](versioning/changelog-release-history.md?view=doc-intel-4.0.0&tabs=javascript&preserve-view=true)
2940

3041
## November 2024
3142

32-
**Document Intelligence v4.0 (2024-11-30) is now generally available (GA)**! The API version corresponds to 2024-11-30. The v4.0 API includes the following changes as listed:
43+
**Document Intelligence REST API v4.0: [**2024-11-30 REST API (GA)**](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) is now generally available (GA)**! The v4.0 REST API includes the following changes:
3344

3445
* [🆕 Batch API](concept-batch-analysis.md)
3546
* Batch API now supports all models, including all read, layout, prebuilt verticals, and custom models.

0 commit comments

Comments
 (0)