Skip to content

Commit 669194e

Browse files
authored
Merge pull request #1935 from MicrosoftDocs/main
12/11/2024 AM Publish
2 parents 8c33861 + 421711f commit 669194e

File tree

141 files changed

+998
-1772
lines changed

Some content is hidden

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

141 files changed

+998
-1772
lines changed

articles/ai-services/.openpublishing.redirection.ai-services.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -790,6 +790,21 @@
790790
"redirect_url": "/azure/ai-services/language-service/question-answering/overview",
791791
"redirect_document_id": true
792792
},
793+
{
794+
"source_path_from_root": "/articles/ai-services/document-intelligence/quickstarts/try-document-intelligence-studio.md",
795+
"redirect_url": "/azure/ai-services/document-intelligence/quickstarts/studio-custom-project",
796+
"redirect_document_id": true
797+
},
798+
{
799+
"source_path_from_root": "/articles/ai-services/document-intelligence/train/custom-generative-extraction.md",
800+
"redirect_url": "/azure/ai-services/document-intelligence/train/custom-model",
801+
"redirect_document_id": false
802+
},
803+
{
804+
"source_path_from_root": "/articles/ai-services/document-intelligence/how-to-guides/build-train-custom-generative-model.md",
805+
"redirect_url": "/azure/ai-services/document-intelligence/how-to-guides/build-a-custom-model",
806+
"redirect_document_id": true
807+
},
793808
{
794809
"source_path_from_root": "/articles/ai-services/openai/how-to/integrate-synapseml.md",
795810
"redirect_url": "/azure/ai-services/openai/overview",

articles/ai-services/document-intelligence/authentication/create-sas-tokens.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ms.topic: how-to
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
8-
ms.date: 07/11/2024
8+
ms.date: 11/19/2024
99
ms.author: lajanuar
1010
---
1111

@@ -16,7 +16,7 @@ ms.author: lajanuar
1616
[!INCLUDE [applies to v4.0 v3.1 v3.0 v2.1](../includes/applies-to-v40-v31-v30-v21.md)]
1717
::: moniker-end
1818

19-
In this article, learn how to create user delegation, shared access signature (SAS) tokens, using the Azure portal or Azure Storage Explorer. User delegation SAS tokens are secured with Microsoft Entra credentials. SAS tokens provide secure, delegated access to resources in your Azure storage account.
19+
In this article, learn how to create user delegation, shared access signature (SAS) tokens, using either the Azure portal or Azure Storage Explorer. User delegation SAS tokens are secured with Microsoft Entra credentials. SAS tokens provide secure, delegated access to resources in your Azure storage account.
2020

2121
:::image type="content" source="../media/sas-tokens/sas-url-token.png" alt-text="Screenshot of storage URI with SAS token appended.":::
2222

@@ -81,7 +81,10 @@ To get started, you need:
8181
> [!NOTE]
8282
> By default, the REST API uses documents located at the root of your container. You can also use data organized in subfolders if specified in the API call. For more information, see [Organize your data in subfolders](../how-to-guides/build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#organize-your-data-in-subfolders-optional).
8383
84-
## Use the Azure portal
84+
## Generating SAS tokens
85+
Once the prerequisites are met and you upload your documents, you can now generate SAS tokens. There are two paths you can take from here; one using the Azure portal and the other using the Azure storage explorer. Select between the two following tabs for more information.
86+
87+
### [**Azure Portal**](#tab/azure-portal)
8588

8689
The Azure portal is a web-based console that enables you to manage your Azure subscription and resources using a graphical user interface (GUI).
8790

@@ -128,17 +131,17 @@ The Azure portal is a web-based console that enables you to manage your Azure su
128131

129132
1. To [construct a SAS URL](#use-your-sas-url-to-grant-access), append the SAS token (URI) to the URL for a storage service.
130133

131-
## Use Azure Storage Explorer
134+
### [**Azure Storage Explorer**](#tab/azure-storage-explorer)
132135

133136
Azure Storage Explorer is a free standalone app that enables you to easily manage your Azure cloud storage resources from your desktop.
134137

135-
### Get started
138+
#### Get started
136139

137140
* You need the [**Azure Storage Explorer**](/azure/vs-azure-tools-storage-manage-with-storage-explorer) app installed in your Windows, macOS, or Linux development environment.
138141

139142
* After the Azure Storage Explorer app is installed, [connect it the storage account](/azure/vs-azure-tools-storage-manage-with-storage-explorer?tabs=windows#connect-to-a-storage-account-or-service) you're using for Document Intelligence.
140143

141-
### Create your SAS tokens
144+
#### Create your SAS tokens
142145

143146
1. Open the Azure Storage Explorer app on your local machine and navigate to your connected **Storage Accounts**.
144147
1. Expand the Storage Accounts node and select **Blob Containers**.

articles/ai-services/document-intelligence/authentication/encrypt-data-at-rest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: erindormier
66
manager: venkyv
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 11/15/2023
9+
ms.date: 11/19/2024
1010
monikerRange: '<=doc-intel-4.0.0'
1111
---
1212

articles/ai-services/document-intelligence/authentication/managed-identities-secured-access.md

Lines changed: 3 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: how-to
9-
ms.date: 05/23/2024
9+
ms.date: 11/19/2024
1010
ms.author: vikurpad
1111
monikerRange: '<=doc-intel-4.0.0'
1212
---
@@ -183,7 +183,7 @@ Next, configure the virtual network to ensure only resources within the virtual
183183

184184
* Select **Next: Resource**.
185185

186-
:::image type="content" source="../media/managed-identities/v2-fr-private-end-basics.png" alt-text="Screenshot showing how to set-up a private endpoint.":::
186+
:::image type="content" source="../media/managed-identities/v2-fr-private-end-basics.png" alt-text="Screenshot showing how to set up a private endpoint.":::
187187

188188
### Configure your virtual network
189189

@@ -263,7 +263,7 @@ That's it! You can now configure secure access for your Document Intelligence re
263263
:::image type="content" source="../media/managed-identities/cors-error.png" alt-text="Screenshot of error message when CORS config is required.":::
264264

265265
**Resolution**:
266-
1. [Configure CORS](../quickstarts/try-document-intelligence-studio.md#configure-cors).
266+
1. [Configure CORS](../quickstarts/studio-custom-project.md#configure-cors).
267267

268268
1. Make sure the client computer can access Document Intelligence resource and storage account, either they are in the same `VNET`, or client IP address is allowed in **Networking > Firewalls and virtual networks** setting page of both Document Intelligence resource and storage account.
269269

articles/ai-services/document-intelligence/authentication/managed-identities.md

Lines changed: 1 addition & 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: how-to
9-
ms.date: 05/23/2024
9+
ms.date: 11/19/2024
1010
ms.author: lajanuar
1111
monikerRange: '<=doc-intel-4.0.0'
1212
---

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

Lines changed: 4 additions & 4 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: conceptual
9-
ms.date: 10/03/2024
9+
ms.date: 11/19/2024
1010
ms.author: lajanuar
1111
---
1212

@@ -20,8 +20,8 @@ A confidence score indicates probability by measuring the degree of statistical
2020

2121
> [!NOTE]
2222
>
23-
> * Field level confidence is getting update to take into account word confidence score starting with **2024-07-31-preview** API version for **custom models**.
24-
> * Confidence scores for tables, table rows and table cells are available starting with the **2024-07-31-preview** API version for **custom models**.
23+
> * Field level confidence includes word confidence scores with **2024-11-30 (GA)** API version for **custom models**.
24+
> * Confidence scores for tables, table rows, and table cells are available starting with the **2024-11-30 (GA)** API version for **custom models**.
2525
2626
Document Intelligence analysis results return an estimated confidence for predicted words, key-value pairs, selection marks, regions, and signatures. Currently, not all document fields return a confidence score.
2727

@@ -95,7 +95,7 @@ Variances in the visual structure of your documents affect the accuracy of your
9595

9696
## Table, row, and cell confidence
9797

98-
With the addition of table, row and cell confidence with the ```2024-02-29-preview``` API and onward, here are some common questions that should help with interpreting the table, row, and cell scores:
98+
Here are some common questions that should help with interpreting the table, row, and cell scores:
9999

100100
**Q:** Is it possible to see a high confidence score for cells, but a low confidence score for the row?<br>
101101

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

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: jaep3347
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 05/23/2024
9+
ms.date: 11/19/2024
1010
ms.author: lajanuar
1111
monikerRange: '>=doc-intel-3.1.0'
1212
---
@@ -17,14 +17,13 @@ monikerRange: '>=doc-intel-3.1.0'
1717

1818
# Document Intelligence add-on capabilities
1919

20-
::: moniker range="doc-intel-4.0.0"
21-
[!INCLUDE [preview-version-notice](../includes/preview-notice.md)]
2220

23-
**This content applies to:** ![checkmark](../media/yes-icon.png) **v4.0 (preview)** | **Previous versions:** ![blue-checkmark](../media/blue-yes-icon.png) [**v3.1 (GA)**](?view=doc-intel-3.1.0&preserve-view=tru)
21+
22+
**This content applies to:** ![checkmark](../media/yes-icon.png) **v4.0 (GA)** | **Previous versions:** ![blue-checkmark](../media/blue-yes-icon.png) [**v3.1 (GA)**](?view=doc-intel-3.1.0&preserve-view=tru)
2423
:::moniker-end
2524

2625
:::moniker range="doc-intel-3.1.0"
27-
**This content applies to:** ![checkmark](../media/yes-icon.png) **v3.1 (GA)** | **Latest version:** ![purple-checkmark](../media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true)
26+
**This content applies to:** ![checkmark](../media/yes-icon.png) **v3.1 (GA)** | **Latest version:** ![purple-checkmark](../media/purple-yes-icon.png) [**v4.0 (GA)**](?view=doc-intel-4.0.0&preserve-view=true)
2827
:::moniker-end
2928

3029
:::moniker range="doc-intel-3.1.0"
@@ -48,35 +47,22 @@ Document Intelligence supports more sophisticated and modular analysis capabilit
4847

4948
* [`languages`](#language-detection)
5049

51-
For `2024-07-31-preview` release and later, the Read model supports searchable PDF output:
52-
53-
* [`Searchable PDF](#searchable-pdf)
50+
* [`Searchable PDF` support](#searchable-pdf)
5451

55-
:::moniker-end
52+
* [`queryFields`](#query-fields)
5653

57-
:::moniker range="doc-intel-4.0.0"
54+
* [`keyValuePairs`](#key-value-pairs)
5855

5956
> [!NOTE]
6057
>
6158
> * Not all add-on capabilities are supported by all models. For more information, *see* [model data extraction](../model-overview.md#model-analysis-features).
6259
>
6360
> * Add-on capabilities are currently not supported for Microsoft Office file types.
64-
65-
Document Intelligence supports optional features that can be enabled and disabled depending on the document extraction scenario. The following add-on capabilities are available for `2023-10-31-preview`, and later releases:
66-
67-
* [`keyValuePairs`](#key-value-pairs)
68-
69-
* [`queryFields`](#query-fields)
70-
71-
> [!NOTE]
72-
>
73-
> The query fields implementation in the 2023-10-30-preview API is different from the last preview release. The new implementation is less expensive and works well with structured documents.
74-
75-
::: moniker-end
61+
:::moniker-end
7662

7763
## Version availability
7864

79-
|Add-on Capability| Add-On/Free|[2024-02-29-preview](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-07-31-preview)&preserve-view=true)|[`2023-07-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[`2022-08-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)|[v2.1 (GA)](/rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true)|
65+
|Add-on Capability| Add-On/Free|**2024-11-30 (GA)**|[`2023-07-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[`2022-08-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)|[v2.1 (GA)](/rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true)|
8066
|----------------|-----------|---|--|---|---|
8167
|Font property extraction|Add-On| ✔️| ✔️| n/a| n/a|
8268
|Formula extraction|Add-On| ✔️| ✔️| n/a| n/a|
@@ -85,8 +71,10 @@ Document Intelligence supports optional features that can be enabled and disable
8571
|Language detection|Free| ✔️| ✔️| n/a| n/a|
8672
|Key value pairs|Free| ✔️|n/a|n/a| n/a|
8773
|Query fields|Add-On*| ✔️|n/a|n/a| n/a|
74+
|Searhable pdf|Add-On**| ✔️|n/a|n/a| n/a|
8875

89-
✱ Add-On - Query fields are priced differently than the other add-on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details.
76+
✱ Add-On - Query fields are priced differently than the other add-on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details. </br>
77+
** Add-On - Searchable pdf is available only with Read model as an add-on feature.
9078

9179
## Supported file formats
9280

@@ -995,8 +983,8 @@ The searchable PDF capability enables you to convert an analog PDF, such as scan
995983

996984
> [!IMPORTANT]
997985
>
998-
> * Currently, the searchable PDF capability is only supported by Read OCR model `prebuilt-read`. When using this feature, please specify the `modelId` as `prebuilt-read`, as other model types will return error for this preview version.
999-
> * Searchable PDF is included with the 2024-07-31-preview `prebuilt-read` model with no usage cost for general PDF consumption.
986+
> * Currently, the searchable PDF capability is only supported by Read OCR model `prebuilt-read`. When using this feature, please specify the `modelId` as `prebuilt-read`.
987+
> * Searchable PDF is included with the 2024-11-30 (GA) `prebuilt-read` model with no usage cost for general PDF consumption.
1000988
1001989
### Use searchable PDF
1002990

@@ -1056,13 +1044,13 @@ Query fields are an add-on capability to extend the schema extracted from any pr
10561044
10571045
> [!NOTE]
10581046
>
1059-
> Document Intelligence Studio query field extraction is currently available with the Layout and Prebuilt models `2024-02-29-preview` `2023-10-31-preview` API and later releases except for the `US tax` models (W2, 1098s, and 1099s models).
1047+
> Document Intelligence Studio query field extraction is currently available with the Layout and Prebuilt models `2024-11-30 (GA) API with the exception of the `US tax` models (W2, 1098s, and 1099s models).
10601048
10611049
### Query field extraction
10621050
10631051
For query field extraction, specify the fields you want to extract and Document Intelligence analyzes the document accordingly. Here's an example:
10641052
1065-
* If you're processing a contract in the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/document), use the `2024-02-29-preview` or `2023-10-31-preview` versions:
1053+
* If you're processing a contract in the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/document), use the **2024-11-30 (GA)** version:
10661054
10671055
:::image type="content" source="../media/studio/query-fields.png" alt-text="Screenshot of the query fields button in Document Intelligence Studio.":::
10681056

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

Lines changed: 2 additions & 2 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: conceptual
9-
ms.date: 10/03/2024
9+
ms.date: 11/19/2024
1010
ms.author: vikurpad
1111
ms.custom:
1212
- references_regions
@@ -130,7 +130,7 @@ Based on its position and styling, a cell can be classified as general content,
130130
**Layout tables differ from document fields extracted from tabular data**. Layout tables are extracted from tabular visual content in the document without considering the semantics of the content. In fact, some layout tables are designed purely for visual layout and don't always contain structured data. The method to extract structured data from documents with diverse visual layout, like itemized details of a receipt, generally requires significant post processing. It's essential to map the row or column headers to structured fields with normalized field names. Depending on the document type, use prebuilt models or train a custom model to extract such structured content. The resulting information is exposed as document fields. Such trained models can also handle tabular data without headers and structured data in nontabular forms, for example the work experience section of a resume.
131131

132132
> [!NOTE]
133-
> Starting with *2024-07-31-preview*, the bounding regions for figures and tables cover only the core content and exclude associated caption and footnotes.
133+
> The bounding regions for figures and tables cover only the core content and exclude associated caption and footnotes.
134134
135135
:::image type="content" source="../media/table.png" alt-text="Layout table":::
136136

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

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,13 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: overview
9-
ms.date: 09/26/2024
9+
ms.date: 11/19/2024
1010
ms.author: lajanuar
1111
---
1212

1313

1414
# Which model should I choose?
1515

16-
::: moniker range="<=doc-intel-3.1.0"
17-
[!INCLUDE [preview-version-notice](../includes/preview-notice.md)]
18-
::: moniker-end
19-
2016
Azure AI Document Intelligence supports a wide variety of models that enable you to add intelligent document processing to your applications and optimize your workflows. Selecting the right model is essential to ensure the success of your enterprise. In this article, we explore the available Document Intelligence models and provide guidance for how to choose the best solution for your projects.
2117

2218
> [!VIDEO https://www.microsoft.com/en-us/videoplayer/embed/RE5fX1b]
@@ -40,6 +36,8 @@ The following decision charts highlight the features of each supported model to
4036
| -----------------|--------------|-------------------|
4137
|**US Unified Tax**|You want to extract key information across all tax forms of W2, 1040, 1090, 1098 from a single file without running any custom classification of your own.|[**US Unified tax model**](../prebuilt/tax-document.md)|
4238
|**US Tax W-2 tax**|You want to extract key information such as salary, wages, and taxes withheld.|[**US tax W-2 model**](../prebuilt/tax-document.md)|
39+
|**US Tax W-4 tax**|You want to extract key information such as claim adjustments, personal information.|[**US tax W-4 model**](../prebuilt/tax-document.md)|
40+
|**US Tax 1095(A,C)**|You want to extract premium tax credit, advance credit payment details.|[**US tax 1095 model**](../prebuilt/tax-document.md)|
4341
|**US Tax 1098**|You want to extract mortgage interest details such as principal, points, and tax.|[**US tax 1098 model**](../prebuilt/tax-document.md)|
4442
|**US Tax 1098-E**|You want to extract student loan interest details such as lender and interest amount.|[**US tax 1098-E model**](../prebuilt/tax-document.md)|
4543
|**US Tax 1098T**|You want to extract qualified tuition details such as scholarship adjustments, student status, and lender information.|[**US tax 1098-T model**](../prebuilt/tax-document.md)|
@@ -73,7 +71,6 @@ The following decision charts highlight the features of each supported model to
7371
| -----------------|--------------|-------------------|
7472
|**Structured, consistent, documents with a static layout**. |Structured forms such as questionnaires or applications. | [**Custom template model**](./../train/custom-template.md)|
7573
|**Structured and semi-structured**.|&#9679; Structured &rightarrow; surveys</br>&#9679; Semi-structured &rightarrow; invoices | [**Custom neural model**](../train/custom-neural.md)|
76-
|**Unstructured documents, documents with varying templates**.|&#9679; Unstructured documents like contracts or letters</br> &#9679; Varying document templates like loan statements from different mortgage companies| [**Custom generative model**](../train/custom-generative-extraction.md)|
7774
|**A collection of several models each trained on similar-type documents.** |&#9679; Supply purchase orders</br>&#9679; Equipment purchase orders</br>&#9679; Furniture purchase orders</br> **All composed into a single model**.| [**Composed custom model**](../train/composed-models.md)|
7875

7976
## Custom classification model
@@ -84,4 +81,4 @@ The following decision charts highlight the features of each supported model to
8481

8582
## Next steps
8683

87-
* [Learn how to process your own forms and documents](../quickstarts/try-document-intelligence-studio.md) with the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio)
84+
* [Learn how to process your own forms and documents](../studio-overview.md) with the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio)

0 commit comments

Comments
 (0)