Skip to content

Commit 811e3c4

Browse files
authored
Merge pull request #270187 from MicrosoftDocs/main
3/26 11:00 AM IST Publish
2 parents 63d6dd3 + 209e954 commit 811e3c4

File tree

53 files changed

+678
-521
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+678
-521
lines changed
5.77 KB
Loading

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Quickstart: Document Intelligence (formerly Form Recognizer) SDKs | REST API "
2+
title: "Quickstart: Document Intelligence (formerly Form Recognizer) client libraries | REST API "
33
titleSuffix: Azure AI services
44
description: Use a Document Intelligence SDK or the REST API to create a forms processing app that extracts key data and structure elements from your documents.
55
author: laujan
@@ -12,7 +12,7 @@ ms.custom:
1212
- devx-track-python
1313
- ignite-2023
1414
ms.topic: quickstart
15-
ms.date: 12/18/2023
15+
ms.date: 03/25/2024
1616
ms.author: lajanuar
1717
zone_pivot_groups: programming-languages-set-formre
1818
---
@@ -50,7 +50,7 @@ zone_pivot_groups: programming-languages-set-formre
5050

5151
::: moniker-end
5252

53-
* Azure AI Document Intelligence / Form Recognizer is a cloud-based Azure AI service that uses machine learning to extract key-value pairs, text, tables and key data from your documents.
53+
* Azure AI Document Intelligence / Form Recognizer is a cloud-based Azure AI service that uses machine learning to extract key-value pairs, text, tables, and key data from your documents.
5454

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

@@ -107,7 +107,7 @@ In this quickstart, you used a document Intelligence model to analyze various fo
107107
## Next steps
108108

109109
>[!div class="nextstepaction"]
110-
> [**For an enhanced experience and advanced model quality, try Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio)
110+
> [**For an enhanced experience and advanced model quality, try Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio) [**For v3.0 to v4.0 migration, see the Changelog Migration guides**](../changelog-release-history.md#march-2024-preview-release).
111111
112112
::: moniker-end
113113

@@ -169,11 +169,10 @@ That's it, well done!
169169

170170
## Next steps
171171

172-
* For an enhanced experience and advanced model quality, try the [Document Intelligence v3.0 Studio](https://formrecognizer.appliedai.azure.com/studio).
172+
* For an enhanced experience and advanced model quality, try the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio).
173173

174-
* The v3.0 Studio supports any model trained with v2.1 labeled data.
175-
176-
* You can refer to the API migration guide for detailed information about migrating from v2.1 to v3.0.
177-
* *See* our [**REST API**](get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) or [**C#**](get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**Java**](get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**JavaScript**](get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), or [**Python**](get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) SDK quickstarts to get started with the v3.0 version.
174+
* The Studio supports any model trained with v2.1 labeled data.
175+
176+
* The changelogs provide detailed information about migrating from v3.1 to v4.0.
178177

179178
::: moniker-end

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "Quickstart: Document Intelligence (formerly Form Recognizer) C# SDK (beta) | v3.1 | v3.0"
33
titleSuffix: Azure AI services
4-
description: 'Form and document processing, data extraction, and analysis using Document Intelligence C# client library SDKs v3.1 or v3.0 '
4+
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.custom:
99
- ignite-2023
1010
ms.topic: include
11-
ms.date: 12/22/2023
11+
ms.date: 03/25/2024
1212
ms.author: lajanuar
1313
monikerRange: 'doc-intel-3.1.0 || doc-intel-3.0.0'
1414
---
@@ -18,7 +18,7 @@ monikerRange: 'doc-intel-3.1.0 || doc-intel-3.0.0'
1818
<!-- markdownlint-disable MD029 -->
1919

2020
:::moniker range="doc-intel-4.0.0"
21-
[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.1/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-02-29-preview&preserve-view=true) | [Package](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0-beta.1)| [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples)|[Supported REST API versions](../../sdk-overview-v4-0.md)
21+
[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.2/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-02-29-preview&preserve-view=true) | [Package](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0-beta.2)| [Samples]( https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/README.md)|[Supported REST API versions](../../sdk-overview-v4-0.md)
2222
:::moniker-end
2323

2424
:::moniker range="doc-intel-3.1.0"
@@ -30,7 +30,7 @@ monikerRange: 'doc-intel-3.1.0 || doc-intel-3.0.0'
3030
[Client library](/dotnet/api/overview/azure/ai.formrecognizer-readme?view=azure-dotnet&preserve-view=true) | [SDK reference](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.FormRecognizer/4.0.0/index.html) | [REST API reference](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument) | [Package](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.0.0) | [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples) |[Supported REST API versions](../../sdk-overview-v3-0.md)
3131
:::moniker-end
3232

33-
In this quickstart, you use the following features to analyze and extract data and values from forms and documents:
33+
In this quickstart, use the following features to analyze and extract data and values from forms and documents:
3434

3535
* [**Layout model**](#layout-model)—Analyze and extract tables, lines, words, and selection marks like radio buttons and check boxes in documents, without the need to train a model.
3636

@@ -108,7 +108,7 @@ In this quickstart, you use the following features to analyze and extract data a
108108

109109
:::image type="content" source="../../media/quickstarts/select-doc-intel-nuget-package.png" alt-text="Screenshot of select NuGet prerelease package window in Visual Studio.":::
110110

111-
1. Select the Browse tab and type Azure.AI.DocumentIntelligence. Choose the **Include prerelease** checkbox and select version 1.0.0-beta.1 from the dropdown menu
111+
1. Select the Browse tab and type Azure.AI.DocumentIntelligence. Choose the **`Include prerelease`** checkbox and select version 1.0.0-beta.1 from the dropdown menu
112112

113113
:::image type="content" source="../../media/quickstarts/doc-intel-preview-package.png" alt-text="Screenshot of select Document Intelligence prerelease NuGet package in Visual Studio.":::
114114

@@ -209,7 +209,7 @@ DocumentIntelligenceClient client = new DocumentIntelligenceClient(new Uri(endpo
209209
//sample document
210210
Uri fileUri = new Uri ("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf");
211211

212-
AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-layout", fileUri);
212+
Operation<AnalyzeResult> operation = await client.AnalyzeDocumentAsync(WaitUntil.Completed, "prebuilt-layout", fileUri);
213213

214214
AnalyzeResult result = operation.Value;
215215

@@ -613,7 +613,7 @@ Once you add a code sample to your application, choose the green **Start** butto
613613
Analyze and extract common fields from specific document types using a prebuilt model. In this example, we analyze an invoice using the **prebuilt-invoice** model.
614614

615615
> [!TIP]
616-
> You aren't limited to invoices—there are several prebuilt models to choose from, each of which has its own set of supported fields. The model to use for the analyze operation depends on the type of document to be analyzed. See [**model data extraction**](../../concept-model-overview.md#model-data-extraction).
616+
> You aren't limited to invoices—there are several prebuilt models to choose from, each of which has its own set of supported fields. The model to use for the `analyze` operation depends on the type of document to be analyzed. See [**model data extraction**](../../concept-model-overview.md#model-data-extraction).
617617
618618
> [!div class="checklist"]
619619
>
@@ -641,7 +641,7 @@ DocumentIntelligenceClient client = new DocumentIntelligenceClient(new Uri(endpo
641641
642642
Uri invoiceUri = new Uri ("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-invoice.pdf");
643643

644-
Operation operation = await client.AnalyzeDocumentAsync(WaitUntil.Completed, "prebuilt-invoice", invoiceUri);
644+
Operation<AnalyzeResult> operation = await client.AnalyzeDocumentAsync(WaitUntil.Completed, "prebuilt-invoice", invoiceUri);
645645

646646
AnalyzeResult result = operation.Value;
647647

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

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
title: "Quickstart: Document Intelligence (formerly Form Recognizer) Java SDK (beta) | v3.1 | v3.0"
33
titleSuffix: Azure AI services
4-
description: Form and document processing, data extraction, and analysis using Document Intelligence Java client library SDKs v3.1 or v3.0
4+
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: 12/19/2023
9+
ms.date: 03/25/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.1/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-02-29-preview&preserve-view=true) | [Package (Maven)](https://mvnrepository.com/artifact/com.azure/azure-ai-documentintelligence/1.0.0-beta.1) | [Samples](https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#examples) |[Supported REST API versions](../../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-beta.2/index.html) | [REST API reference](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-02-29-preview&preserve-view=true) | [Package (Maven)](https://central.sonatype.com/artifact/com.azure/azure-ai-documentintelligence/1.0.0-beta.2) | [Samples]( https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/README.md) |[Supported REST API versions](../../sdk-overview-v4-0.md)
1717
:::moniker-end
1818

1919
:::moniker range="doc-intel-3.1.0"
@@ -24,7 +24,7 @@ ms.author: lajanuar
2424
[Client library](/java/api/overview/azure/ai-formrecognizer-readme?view=azure-java-stable&preserve-view=true) | [SDK reference](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-formrecognizer/4.0.0/index.html) | [REST API reference](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument) | [Package (Maven)](https://mvnrepository.com/artifact/com.azure/azure-ai-formrecognizer/4.0.0) | [Samples](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples)|[Supported REST API versions](../../sdk-overview-v3-0.md)
2525
:::moniker-end
2626

27-
In this quickstart you'll, use the following features to analyze and extract data and values from forms and documents:
27+
In this quickstart, use the following features to analyze and extract data and values from forms and documents:
2828

2929
* [**Layout**](#layout-model)—Analyze and extract tables, lines, words, and selection marks like radio buttons and check boxes in documents, without the need to train a model.
3030

@@ -128,7 +128,7 @@ Open the project's *build.gradle.kts* file in your IDE. Copay and past the follo
128128
mavenCentral()
129129
}
130130
dependencies {
131-
implementation group: 'com.azure', name: 'azure-ai-documentintelligence', version: '1.0.0-beta.1'
131+
implementation group: 'com.azure', name: 'azure-ai-documentintelligence', version: '1.0.0-beta.2'
132132

133133
}
134134
```
@@ -200,8 +200,6 @@ To interact with the Document Intelligence service, you need to create an instan
200200

201201
:::moniker-end
202202

203-
204-
205203
1. From the doc-intel-app directory, run the following command:
206204

207205
```console
@@ -222,7 +220,7 @@ To interact with the Document Intelligence service, you need to create an instan
222220
> * Open a PowerShell window in your project directory by holding down the Shift key and right-clicking the folder.
223221
> * Type the following command **New-Item DocIntelligence.java**.
224222

225-
1. Open the `DocIntelligence.java` file and select one of the following code samples to copy and paste into your application:
223+
1. Open the `DocIntelligence.java` file. Copy and paste one of the following code samples into your application:
226224

227225
* [**Layout**](#layout-model)
228226

@@ -240,7 +238,7 @@ To interact with the Document Intelligence service, you need to create an instan
240238
> * Open a PowerShell window in your project directory by holding down the Shift key and right-clicking the folder.
241239
> * Type the following command **New-Item FormRecognizer.java**.
242240

243-
1. Open the `FormRecognizer.java` file and select one of the following code samples to copy and paste into your application:
241+
1. Open the `FormRecognizer.java` file. Copy and paste one of the following code samples into your application:
244242

245243
* [**Layout**](#layout-model)
246244

@@ -296,8 +294,8 @@ public class DocIntelligence {
296294
String documentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf";
297295
String modelId = "prebuilt-layout";
298296

299-
SyncPoller < OperationResult, AnalyzeResult > analyzeLayoutResultPoller =
300-
client.beginAnalyzeDocumentFromUrl(modelId, documentUrl);
297+
SyncPoller <AnalyzeResultOperation, AnalyzeResultOperation> analyzeLayoutResultPoller =
298+
client.beginAnalyzeDocument(modelId, documentUrl);
301299

302300
AnalyzeResult analyzeLayoutResult = analyzeLayoutPoller.getFinalResult().getAnalyzeResult();
303301

@@ -500,7 +498,7 @@ Here's a snippet of the expected output:
500498
Cell 'NASDAQ', has row index 4 and column index 2.
501499
```
502500

503-
To view the entire output,visit the Azure samples repository on GitHub to view the [layout model output](https://github.com/Azure-Samples/cognitive-services-quickstart-code/blob/master/java/FormRecognizer/v3-java-sdk-layout-output.md).
501+
To view the entire output, visit the Azure samples repository on GitHub to view the [layout model output](https://github.com/Azure-Samples/cognitive-services-quickstart-code/blob/master/java/FormRecognizer/v3-java-sdk-layout-output.md).
504502

505503
:::moniker-end
506504

@@ -623,7 +621,7 @@ After you add a code sample to your application, navigate back to your main proj
623621
Analyze and extract common fields from specific document types using a prebuilt model. In this example, we analyze an invoice using the **prebuilt-invoice** model.
624622

625623
> [!TIP]
626-
> You aren't limited to invoices—there are several prebuilt models to choose from, each of which has its own set of supported fields. The model to use for the analyze operation depends on the type of document to be analyzed. See [**model data extraction**](../../concept-model-overview.md#model-data-extraction).
624+
> You aren't limited to invoices—there are several prebuilt models to choose from, each of which has its own set of supported fields. The model to use for the `analyze` operation depends on the type of document to be analyzed. See [**model data extraction**](../../concept-model-overview.md#model-data-extraction).
627625

628626
> [!div class="checklist"]
629627
>
@@ -678,7 +676,7 @@ public class DocIntelligence {
678676
.buildClient();
679677

680678
SyncPoller < OperationResult, AnalyzeResult > analyzeLayoutResultPoller =
681-
client.beginAnalyzeDocumentFromUrl(modelId, invoiceUrl);
679+
client.beginAnalyzeDocument(modelId, invoiceUrl);
682680

683681
AnalyzeResult analyzeInvoiceResult = analyzeInvoicesPoller.getFinalResult().getAnalyzeResult();
684682

@@ -1008,7 +1006,7 @@ Here's a snippet of the expected output:
10081006
Invoice Date: 2019-11-15, confidence: 0.97
10091007
```
10101008

1011-
To view the entire output, visit the Azure samples repository on GitHub to view the [prebuilt invoice model output](https://github.com/Azure-Samples/cognitive-services-quickstart-code/blob/master/java/FormRecognizer/v3-java-sdk-prebuilt-invoice-output.md)
1009+
To view the entire output, visit the Azure samples repository on GitHub to view the [prebuilt invoice model output](https://github.com/Azure-Samples/cognitive-services-quickstart-code/blob/master/java/FormRecognizer/v3-java-sdk-prebuilt-invoice-output.md).
10121010

10131011
:::moniker-end
10141012

0 commit comments

Comments
 (0)