Skip to content

Commit 4888fc6

Browse files
authored
Merge pull request #246898 from MicrosoftDocs/release-ga-doc-intel-v3-1
Release ga doc intel v3 1--scheduled release at 10AM of 8/01
2 parents 26cb1a9 + ae68f99 commit 4888fc6

File tree

77 files changed

+3479
-1371
lines changed

Some content is hidden

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

77 files changed

+3479
-1371
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.subservice: forms-recognizer
99
ms.topic: reference
1010
ms.date: 07/18/2023
1111
ms.author: lajanuar
12-
monikerRange: '<=doc-intel-3.0.0'
12+
monikerRange: '<=doc-intel-3.1.0'
1313
---
1414

1515
<!-- markdownlint-disable MD001 -->

articles/ai-services/document-intelligence/choose-model-feature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.subservice: forms-recognizer
99
ms.topic: overview
1010
ms.date: 07/18/2023
1111
ms.author: lajanuar
12-
monikerRange: 'doc-intel-3.0.0'
12+
monikerRange: '>=doc-intel-3.0.0'
1313
---
1414

1515

articles/ai-services/document-intelligence/concept-accuracy-confidence.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ ms.subservice: forms-recognizer
99
ms.topic: conceptual
1010
ms.date: 07/18/2023
1111
ms.author: lajanuar
12-
monikerRange: '<=doc-intel-3.0.0'
12+
monikerRange: '<=doc-intel-3.1.0'
1313
---
1414

1515

1616

1717

1818
# Custom models: accuracy and confidence scores
1919

20-
[!INCLUDE [applies to v3.0 and v2.1](includes/applies-to-v3-0-v2-1.md)]
20+
[!INCLUDE [applies to v3.1, v3.0, and v2.1](includes/applies-to-v3-1-v3-0-v2-1.md)]
2121

2222
> [!NOTE]
2323
>

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

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ ms.subservice: forms-recognizer
99
ms.topic: conceptual
1010
ms.date: 07/18/2023
1111
ms.author: lajanuar
12-
monikerRange: 'doc-intel-3.0.0'
12+
monikerRange: 'doc-intel-3.1.0'
1313
---
1414

1515

1616

1717

1818
<!-- markdownlint-disable MD033 -->
1919

20-
# Document Intelligence add-on capabilities (preview)
20+
# Document Intelligence add-on capabilities
2121

22-
**This article applies to:** ![Document Intelligence checkmark](media/yes-icon.png) **The latest [public preview SDK](sdk-preview.md) supported by Document Intelligence REST API version [2023-02-28-preview](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-02-28-preview/operations/AnalyzeDocument)**.
22+
[!INCLUDE [applies to v3.1](includes/applies-to-v3-1.md)]
2323

2424
> [!NOTE]
2525
>
26-
> Add-on capabilities for Document Intelligence Studio are only available within the Read and Layout models for the `2023-02-28-preview` release.
26+
> Add-on capabilities for Document Intelligence Studio are available with the Read and Layout models for the `2023-07-31` (GA)release.
2727
28-
Document Intelligence now supports more sophisticated analysis capabilities. These optional capabilities can be enabled and disabled depending on the scenario of the document extraction. There are three add-on capabilities available for the `2023-02-28-preview`:
28+
Document Intelligence now supports more sophisticated analysis capabilities. These optional capabilities can be enabled and disabled depending on the scenario of the document extraction. There are three add-on capabilities available for the `2023-07-31` (GA) release:
2929

3030
* [`ocr.highResolution`](#high-resolution-extraction)
3131

@@ -37,12 +37,26 @@ Document Intelligence now supports more sophisticated analysis capabilities. The
3737

3838
The task of recognizing small text from large-size documents, like engineering drawings, is a challenge. Often the text is mixed with other graphical elements and has varying fonts, sizes and orientations. Moreover, the text may be broken into separate parts or connected with other symbols. Document Intelligence now supports extracting content from these types of documents with the `ocr.highResolution` capability. You get improved quality of content extraction from A1/A2/A3 documents by enabling this add-on capability.
3939

40+
## Barcode extraction
41+
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.
43+
44+
### Supported barcode types
45+
46+
| **Barcode Type** | **Example** |
47+
| --- | --- |
48+
| QR Code |:::image type="content" source="media/barcodes/qr-code.png" alt-text="Screenshot of the QR Code.":::|
49+
| Code 39 |:::image type="content" source="media/barcodes/code-39.png" alt-text="Screenshot of the Code 39.":::|
50+
| Code 128 |:::image type="content" source="media/barcodes/code-128.png" alt-text="Screenshot of the Code 128.":::|
51+
| UPC (UPC-A & UPC-E) |:::image type="content" source="media/barcodes/upc.png" alt-text="Screenshot of the UPC.":::|
52+
| PDF417 |:::image type="content" source="media/barcodes/pdf-417.png" alt-text="Screenshot of the PDF417.":::|
53+
4054
## Formula extraction
4155

4256
The `ocr.formula` capability extracts all identified formulas, such as mathematical equations, in the `formulas` collection as a top level object under `content`. Inside `content`, detected formulas are represented as `:formula:`. Each entry in this collection represents a formula that includes the formula type as `inline` or `display`, and its LaTeX representation as `value` along with its `polygon` coordinates. Initially, formulas appear at the end of each page.
4357

4458
> [!NOTE]
45-
> The `confidence` score is hard-coded for the `2023-02-28` public preview release.
59+
> The `confidence` score is hard-coded.
4660
4761
```json
4862
"content": ":formula:",

articles/ai-services/document-intelligence/concept-analyze-document-response.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ ms.topic: conceptual
1010
ms.date: 07/18/2023
1111
ms.author: vikurpad
1212
ms.custom: references_regions
13-
monikerRange: 'doc-intel-3.0.0'
13+
monikerRange: '>=doc-intel-3.0.0'
1414
---
1515

1616

1717

1818
# Analyze document API response
1919

20+
[!INCLUDE [applies to v3.1 and v3.0](includes/applies-to-v3-1-v3-0.md)]
21+
2022
In this article, let's examine the different objects returned as part of the analyze document response and how to use the document analysis API response in your applications.
2123

2224
## Analyze document request

articles/ai-services/document-intelligence/concept-business-card.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ ms.subservice: forms-recognizer
99
ms.topic: conceptual
1010
ms.date: 07/18/2023
1111
ms.author: lajanuar
12-
monikerRange: '<=doc-intel-3.0.0'
12+
monikerRange: '<=doc-intel-3.1.0'
1313
---
1414

1515
<!-- markdownlint-disable MD033 -->
1616

1717
# Document Intelligence business card model
1818

19-
::: moniker range="doc-intel-3.0.0"
20-
[!INCLUDE [applies to v3.0](includes/applies-to-v3-0.md)]
19+
::: moniker range=">=doc-intel-3.0.0"
20+
[!INCLUDE [applies to v3.1 and v3.0](includes/applies-to-v3-1-v3-0.md)]
2121
::: moniker-end
2222

2323
::: moniker range="doc-intel-2.1.0"
@@ -30,7 +30,7 @@ The Document Intelligence business card model combines powerful Optical Characte
3030

3131
Business cards are a great way to represent a business or a professional. The company logo, fonts and background images found in business cards help promote the company branding and differentiate it from others. Applying OCR and machine-learning based techniques to automate scanning of business cards is a common image processing scenario. Enterprise systems used by sales and marketing teams typically have business card data extraction capability integration into for the benefit of their users.
3232

33-
::: moniker range="doc-intel-3.0.0"
33+
::: moniker range=">=doc-intel-3.0.0"
3434
***Sample business card processed with [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=businessCard)***
3535

3636
:::image type="content" source="media/studio/overview-business-card-studio.png" alt-text="Screenshot of a sample business card analyzed in the Document Intelligence Studio." lightbox="./media/overview-business-card.jpg":::
@@ -47,13 +47,13 @@ Business cards are a great way to represent a business or a professional. The co
4747

4848
## Development options
4949

50-
::: moniker range="doc-intel-3.0.0"
50+
::: moniker range=">=doc-intel-3.0.0"
5151

5252
Document Intelligence v3.0 supports the following tools:
5353

5454
| Feature | Resources | Model ID |
5555
|----------|-------------|-----------|
56-
|**Business card model**| <ul><li>[**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</li><li>[**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</li><li>[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li></ul>|**prebuilt-businessCard**|
56+
|**Business card model**| <ul><li>[**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</li><li>[**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-07-31/operations/AnalyzeDocument)</li><li>[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li></ul>|**prebuilt-businessCard**|
5757

5858
::: moniker-end
5959

@@ -63,7 +63,7 @@ Document Intelligence v2.1 supports the following tools:
6363

6464
| Feature | Resources |
6565
|----------|-------------------------|
66-
|**Business card model**| <ul><li>[**Document Intelligence labeling tool**](https://fott-2-1.azurewebsites.net/prebuilts-analyze)</li><li>[**REST API**](./how-to-guides/use-sdk-rest-api.md?pivots=programming-language-rest-api&preserve-view=true&tabs=windows&view=doc-intel-2.1.0#analyze-business-cards)</li><li>[**Client-library SDK**](~/articles/ai-services/document-intelligence/how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true)</li><li>[**Document Intelligence Docker container**](containers/install-run.md?tabs=business-card#run-the-container-with-the-docker-compose-up-command)</li></ul>|
66+
|**Business card model**| <ul><li>[**Document Intelligence labeling tool**](https://fott-2-1.azurewebsites.net/prebuilts-analyze)</li><li>[**REST API**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-3.0.0&tabs=windows&pivots=programming-language-rest-api&preserve-view=true)</li><li>[**Client-library SDK**](~/articles/ai-services/document-intelligence/how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true)</li><li>[**Document Intelligence Docker container**](containers/install-run.md?tabs=business-card#run-the-container-with-the-docker-compose-up-command)</li></ul>|
6767

6868
::: moniker-end
6969

@@ -77,12 +77,12 @@ See how data, including name, job title, address, email, and company name, is ex
7777

7878
:::image type="content" source="media/containers/keys-and-endpoint.png" alt-text="Screenshot: keys and endpoint location in the Azure portal.":::
7979

80-
::: moniker range="doc-intel-3.0.0"
80+
::: moniker range=">=doc-intel-3.0.0"
8181

8282
#### Document Intelligence Studio
8383

8484
> [!NOTE]
85-
> Document Intelligence Studio is available with the v3.0 API.
85+
> Document Intelligence Studio is available with v3.1 and v3.0 APIs.
8686
8787
1. On the Document Intelligence Studio home page, select **Business cards**.
8888

@@ -139,7 +139,7 @@ See how data, including name, job title, address, email, and company name, is ex
139139

140140
## Input requirements
141141

142-
::: moniker range="doc-intel-3.0.0"
142+
::: moniker range=">=doc-intel-3.0.0"
143143

144144
[!INCLUDE [input requirements](./includes/input-requirements.md)]
145145

@@ -153,7 +153,7 @@ See how data, including name, job title, address, email, and company name, is ex
153153

154154
::: moniker-end
155155

156-
::: moniker range="doc-intel-3.0.0"
156+
::: moniker range=">=doc-intel-3.0.0"
157157

158158
## Supported languages and locales
159159

@@ -223,7 +223,7 @@ See how data, including name, job title, address, email, and company name, is ex
223223

224224
## Next steps
225225

226-
::: moniker range="doc-intel-3.0.0"
226+
::: moniker range=">=doc-intel-3.0.0"
227227

228228
* Try processing your own forms and documents with the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio)
229229

articles/ai-services/document-intelligence/concept-composed-models.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ ms.subservice: forms-recognizer
99
ms.topic: conceptual
1010
ms.date: 07/18/2023
1111
ms.author: lajanuar
12-
monikerRange: '<=doc-intel-3.0.0'
12+
monikerRange: '<=doc-intel-3.1.0'
1313
---
1414

1515
# Document Intelligence composed custom models
1616

17-
::: moniker range="doc-intel-3.0.0"
18-
[!INCLUDE [applies to v3.0](includes/applies-to-v3-0.md)]
17+
::: moniker range=">=doc-intel-3.0.0"
18+
[!INCLUDE [applies to v3.1 and v3.0](includes/applies-to-v3-1-v3-0.md)]
1919
::: moniker-end
2020

2121
::: moniker range="doc-intel-2.1.0"
@@ -40,7 +40,7 @@ With composed models, you can assign multiple custom models to a composed model
4040

4141
::: moniker-end
4242

43-
::: moniker range="doc-intel-3.0.0"
43+
::: moniker range=">=doc-intel-3.0.0"
4444

4545
With the introduction of [**custom classification models**](./concept-custom-classifier.md), you can choose to use a [**composed model**](./concept-composed-models.md) or [**classification model**](concept-custom-classifier.md) as an explicit step before analysis. For a deeper understanding of when to use a classification or composed model, _see_ [**Custom classification models**](concept-custom-classifier.md#compare-custom-classification-and-composed-models).
4646

@@ -69,13 +69,13 @@ With the introduction of [**custom classification models**](./concept-custom-cla
6969

7070
## Development options
7171

72-
::: moniker range="doc-intel-3.0.0"
72+
::: moniker range=">=doc-intel-3.0.0"
7373
The following resources are supported by Document Intelligence **v3.0** :
7474

7575
| Feature | Resources |
7676
|----------|-------------|
77-
|_**Custom model**_| <ul><li>[Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</li><li>[REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</li><li>[C# SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[Java SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[JavaScript SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[Python SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li></ul>|
78-
| _**Composed model**_| <ul><li>[Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</li><li>[REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/ComposeDocumentModel)</li><li>[C# SDK](/dotnet/api/azure.ai.formrecognizer.training.formtrainingclient.startcreatecomposedmodel)</li><li>[Java SDK](/java/api/com.azure.ai.formrecognizer.training.formtrainingclient.begincreatecomposedmodel)</li><li>[JavaScript SDK](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-latest#@azure-ai-form-recognizer-documentmodeladministrationclient-begincomposemodel&preserve-view=true)</li><li>[Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)</li></ul>|
77+
|_**Custom model**_| <ul><li>[Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</li><li>[REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-07-31/operations/AnalyzeDocument)</li><li>[C# SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[Java SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[JavaScript SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li><li>[Python SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</li></ul>|
78+
| _**Composed model**_| <ul><li>[Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</li><li>[REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-07-31/operations/ComposeDocumentModel)</li><li>[C# SDK](/dotnet/api/azure.ai.formrecognizer.training.formtrainingclient.startcreatecomposedmodel)</li><li>[Java SDK](/java/api/com.azure.ai.formrecognizer.training.formtrainingclient.begincreatecomposedmodel)</li><li>[JavaScript SDK](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-latest#@azure-ai-form-recognizer-documentmodeladministrationclient-begincomposemodel&preserve-view=true)</li><li>[Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)</li></ul>|
7979
::: moniker-end
8080

8181
::: moniker range="doc-intel-2.1.0"
@@ -84,7 +84,7 @@ Document Intelligence v2.1 supports the following resources:
8484

8585
| Feature | Resources |
8686
|----------|-------------------------|
87-
|_**Custom model**_| <ul><li>[Document Intelligence labeling tool](https://fott-2-1.azurewebsites.net)</li><li>[REST API](./how-to-guides/use-sdk-rest-api.md?pivots=programming-language-rest-api&preserve-view=true&tabs=windows&view=doc-intel-2.1.0#analyze-forms-with-a-custom-model)</li><li>[Client library SDK](~/articles/ai-services/document-intelligence/how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true)</li><li>[Document Intelligence Docker container](containers/install-run.md?tabs=custom#run-the-container-with-the-docker-compose-up-command)</li></ul>|
87+
|_**Custom model**_| <ul><li>[Document Intelligence labeling tool](https://fott-2-1.azurewebsites.net)</li><li>[REST API](how-to-guides/compose-custom-models.md?view=doc-intel-2.1.0&tabs=rest&preserve-view=true)</li><li>[Client library SDK](~/articles/ai-services/document-intelligence/how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true)</li><li>[Document Intelligence Docker container](containers/install-run.md?tabs=custom#run-the-container-with-the-docker-compose-up-command)</li></ul>|
8888
| _**Composed model**_ |<ul><li>[Document Intelligence labeling tool](https://fott-2-1.azurewebsites.net/)</li><li>[REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/Compose)</li><li>[C# SDK](/dotnet/api/azure.ai.formrecognizer.training.createcomposedmodeloperation?view=azure-dotnet&preserve-view=true)</li><li>[Java SDK](/java/api/com.azure.ai.formrecognizer.models.createcomposedmodeloptions?view=azure-java-stable&preserve-view=true)</li><li>JavaScript SDK</li><li>[Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)</li></ul>|
8989
::: moniker-end
9090

0 commit comments

Comments
 (0)