Skip to content

Commit be9d24f

Browse files
authored
Merge pull request #3534 from laujan/patch-2
Update studio documentation
2 parents 7582c8e + 586e43b commit be9d24f

File tree

8 files changed

+189
-154
lines changed

8 files changed

+189
-154
lines changed

articles/ai-services/document-intelligence/how-to-guides/create-document-intelligence-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Let's get started:
4040
* **Subscription**. Select your current subscription.
4141
* **Resource group**. The [Azure resource group](/azure/cloud-adoption-framework/govern/resource-consistency/resource-access-management#what-is-an-azure-resource-group) that contains your resource. You can create a new group or add it to an existing group.
4242
* **Region**. Select your local region.
43-
* **Name**. Enter a name for your resource. We recommend using a descriptive name, for example *YourNameFormRecognizer*.
43+
* **Name**. Enter a name for your resource. We recommend using a descriptive name, for example *YourNameDocumentIntelligence*.
4444
* **Pricing tier**. The cost of your resource depends on the pricing tier you choose and your usage. For more information, see [pricing details](https://azure.microsoft.com/pricing/details/cognitive-services/). You can use the free pricing tier (F0) to try the service, and upgrade later to a paid tier for production.
4545

4646
1. Select **Review + Create**.

articles/ai-services/document-intelligence/model-overview.md

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

@@ -36,7 +36,7 @@ ms.author: lajanuar
3636
::: moniker-end
3737

3838
::: moniker range=">=doc-intel-2.1.0"
39-
Azure AI Document Intelligence supports a wide variety of models that enable you to add intelligent document processing to your apps and flows. You can use a prebuilt domain-specific model or train a custom model tailored to your specific business need and use cases. Document Intelligence can be used with the REST API or Python, C#, Java, and JavaScript client libraries.
39+
Azure AI Document Intelligence supports a wide variety of models that enable you to add intelligent document processing to your apps and flows. You can use a prebuilt domain-specific model or train a custom model tailored to your specific business needs and use cases. Document Intelligence can be used with the REST API or Python, C#, Java, and JavaScript client libraries.
4040
::: moniker-end
4141

4242
> [!NOTE]
@@ -48,11 +48,11 @@ ms.author: lajanuar
4848

4949
The following table shows the available models for each stable API:
5050

51-
|**Model Type**| **Model**|• [2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&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)|
51+
|**Model Type**| **Model**|[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&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)|
5252
|----------------|-----------|---|--|---|---|
5353
|Document analysis models|[Read](prebuilt/read.md) | ✔️| ✔️| ✔️| n/a|
5454
|Document analysis models|[Layout](prebuilt/layout.md) | ✔️| ✔️| ✔️| ✔️|
55-
|Document analysis models|[General document](prebuilt/general-document.md) |moved to layout**| ✔️| ✔️| n/a|
55+
|Document analysis models|[** General document](prebuilt/general-document.md) |**supported in<br>layout model**| ✔️| ✔️| n/a|
5656
|Prebuilt models|[Bank Check](concept-bank-check.md) | ✔️| n/a| n/a| n/a|
5757
|Prebuilt models|[Bank Statement](concept-bank-statement.md) | ✔️| n/a| n/a| n/a|
5858
|Prebuilt models|[Paystub](concept-pay-stub.md) | ✔️| n/a| n/a| n/a|
@@ -82,8 +82,8 @@ The following table shows the available models for each stable API:
8282
|Custom extraction model|[Custom composed](train/composed-models.md) | ✔️| ✔️| ✔️| ✔️|
8383
|All models|[Add-on capabilities](concept-add-on-capabilities.md) | ✔️| ✔️| n/a| n/a|
8484

85-
\* - Contains submodels. See the model specific information for supported variations and subtypes. </br>
86-
\**- All the capabilites of General Document model are available in layout model. General model is no longer supported.
85+
\* Contains submodels. See the model specific information for supported variations and subtypes.</br>
86+
\** All the General Document model capabilities are available in layout model. General model is no longer supported.
8787

8888
### Latency
8989

@@ -252,7 +252,7 @@ The US mortgage document models analyze and extract key fields including borrowe
252252

253253
The contract model analyzes and extracts key fields from check including check details, account details, amount, memo, is extracted from US bank checks.
254254

255-
***Sample bank check processed using [Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=check.us)***:
255+
***A bank check sample processed using [Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=check.us)***:
256256

257257
:::image type="content" source="media/studio/analyze-bank-check.png" alt-text="Screenshot of bank check model extraction using Document Intelligence Studio.":::
258258

@@ -263,7 +263,7 @@ The US mortgage document models analyze and extract key fields including borrowe
263263

264264
:::image type="icon" source="media/overview/icon-contract.png":::
265265

266-
The bank statement model analyzes and extracts key fields and line items from US bank statements account number, bank details, statement details and transaction details.
266+
The bank statement model analyzes and extracts key fields and line items from US bank statements account number, bank details, statement details, and transaction details.
267267

268268
***Sample bank statement processed using [Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=bankStatement.us)***:
269269

@@ -410,7 +410,7 @@ A composed model is created by taking a collection of custom models and assignin
410410
[!INCLUDE [input requirements](./includes/input-requirements.md)]
411411

412412
> [!NOTE]
413-
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) does not support the BMP file format. This is a limitation of the tool not the Document Intelligence Service.
413+
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) doesn't support the BMP file format. The limitation is derived from the tool not the Document Intelligence Service.
414414
415415
### Version migration
416416

@@ -531,7 +531,7 @@ A composed model is created by taking a collection of custom models and assignin
531531
[!INCLUDE [input requirements](./includes/input-requirements.md)]
532532

533533
> [!NOTE]
534-
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) does not support the BMP file format. This is a limitation of the tool not the Document Intelligence Service.
534+
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) doesn't support the BMP file format. The limitation is derived from the tool not the Document Intelligence Service.
535535
536536
### Version migration
537537

articles/ai-services/document-intelligence/prebuilt/layout.md

Lines changed: 15 additions & 14 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: 01/16/2025
9+
ms.date: 03/17/2025
1010
ms.author: lajanuar
1111
---
1212

@@ -86,7 +86,7 @@ See how data, including text, tables, table headers, selection marks, and struct
8686

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

89-
After you retrieve you key and endpoint, you can use the following development options to build and deploy your Document Intelligence applications:
89+
After you retrieve your key and endpoint, use the following development options to build and deploy your Document Intelligence applications:
9090

9191
### [REST API](#tab/rest)
9292

@@ -103,7 +103,7 @@ After you retrieve you key and endpoint, you can use the following development o
103103
### [Document Intelligence Studio](#tab/studio)
104104

105105
* [Studio](https://documentintelligence.ai.azure.com/studio)
106-
* [How-to guide](../studio-overview.md#authentication-in-studio)
106+
* [How-to guide](../quickstarts/get-started-studio.md#authentication-in-studio)
107107

108108
---
109109

@@ -220,9 +220,9 @@ The new machine-learning based page object detection extracts logical roles like
220220

221221
### Text, lines, and words
222222

223-
The document layout model in Document Intelligence extracts print and handwritten style text as `lines` and `words`. The `styles` collection ../includes any handwritten style for lines if detected along with the spans pointing to the associated text. This feature applies to [supported handwritten languages](../language-support/prebuilt.md).
223+
The document layout model in Document Intelligence extracts print and handwritten style text as `lines` and `words`. The `styles` collection includes any handwritten style for lines if detected along with the spans pointing to the associated text. This feature applies to [supported handwritten languages](../language-support/prebuilt.md).
224224

225-
For Microsoft Word, Excel, PowerPoint, and HTML, Document Intelligence v4.0 2024-11-30 (GA) Layout model extract all embedded text as is. Texts are extracted as words and paragraphs. Embedded images aren't supported.
225+
For Microsoft Word, Excel, PowerPoint, and HTML, Document Intelligence v4.0 `2024-11-30` (GA) Layout model extract all embedded text as is. Texts are extracted as words and paragraphs. Embedded images aren't supported.
226226

227227
#### [Sample code](#tab/sample-code)
228228

@@ -343,8 +343,8 @@ Here are a few factors to consider when using the Document Intelligence bale ext
343343

344344
> [!NOTE]
345345
>
346-
> * Table analysis is not supported if the input file is XLSX.
347-
> * For *2024-11-30 (GA)*, the bounding regions for figures and tables cover only the core content and exclude associated caption and footnotes.
346+
> * Table analysis isn't supported if the input file is XLSX.
347+
> * For `2024-11-30` (GA), the bounding regions for figures and tables cover only the core content and exclude associated caption and footnotes.
348348
349349
#### [Sample code](#tab/sample-code)
350350

@@ -399,7 +399,8 @@ if result.tables:
399399
The Layout API can output the extracted text in markdown format. Use the `outputContentFormat=markdown` to specify the output format in markdown. The markdown content is output as part of the `content` section.
400400

401401
> [!NOTE]
402-
> For v4.0 *2024-11-30 (GA)*, the representation of tables is changed to HTML tables to enable rendering of merged cells, multi-row headers, etc. Another related change is to use Unicode checkbox characters ☒ and ☐ for selection marks instead of :selected: and :unselected:. Note that this means that the content of selection mark fields will contain :selected: even though their spans refer to Unicode characters in the top-level span.
402+
>
403+
> For v4.0 `2024-11-30` (GA), the representation of tables is changed to HTML tables to enable rendering of merged cells, multi-row headers, etc. Another related change is to use Unicode checkbox characters ☒ and ☐ for selection marks instead of `:selected:` and `:unselected:`. This update means that the content of selection mark fields contains `:selected:` even though their spans refer to Unicode characters in the top-level span.
403404
404405
#### [Sample code](#tab/sample-code)
405406

@@ -472,7 +473,7 @@ When *output=figures* is specified during the initial analyze operation, the ser
472473
`FigureId` is included in each figure object, following an undocumented convention of `{pageNumber}.{figureIndex}` where `figureIndex` resets to one per page.
473474

474475
> [!NOTE]
475-
> For v4.0 *2024-11-30 (GA)*, the bounding regions for figures and tables cover only the core content and exclude associated caption and footnotes.
476+
> For v4.0 `2024-11-30` (GA), the bounding regions for figures and tables cover only the core content and exclude associated caption and footnotes.
476477
477478
#### [Sample code](#tab/sample-code)
478479

@@ -637,7 +638,7 @@ Supported file formats:
637638

638639
* For custom extraction model training, the total size of training data is 50 MB for template model and `1` GB for the neural model.
639640

640-
* For custom classification model training, the total size of training data is `1` GB with a maximum of 10,000 pages. For 2024-11-30 (GA), the total size of training data is `2` GB with a maximum of 10,000 pages.
641+
* For custom classification model training, the total size of training data is `1` GB with a maximum of 10,000 pages. For `2024-11-30` (GA), the total size of training data is `2` GB with a maximum of 10,000 pages.
641642

642643
:::moniker-end
643644

@@ -688,7 +689,7 @@ After you retrieve you key and endpoint, you can use the following development o
688689
### [Document Intelligence Studio](#tab/studio)
689690

690691
* [Studio](https://documentintelligence.ai.azure.com/studio)
691-
* [How-to guide](../studio-overview.md#authentication-in-studio)
692+
* [How-to guide](../quickstarts/get-started-studio.md#authentication-in-studio)
692693

693694
---
694695

@@ -901,7 +902,7 @@ The new machine-learning based page object detection extracts logical roles like
901902

902903
The document layout model in Document Intelligence extracts print and handwritten style text as `lines` and `words`. The `styles` collection ../includes any handwritten style for lines if detected along with the spans pointing to the associated text. This feature applies to [supported handwritten languages](../language-support/prebuilt.md).
903904

904-
For Microsoft Word, Excel, PowerPoint, and HTML, Document Intelligence v4.0 2024-11-30 (GA) Layout model extract all embedded text as is. Texts are extracted as words and paragraphs. Embedded images aren't supported.
905+
For Microsoft Word, Excel, PowerPoint, and HTML, Document Intelligence v4.0 `2024-11-30` (GA) Layout model extract all embedded text as is. Texts are extracted as words and paragraphs. Embedded images aren't supported.
905906

906907
:::moniker-end
907908

@@ -1078,8 +1079,8 @@ Here are a few factors to consider when using the Document Intelligence bale ext
10781079

10791080
> [!NOTE]
10801081
>
1081-
> * Table analysis is not supported if the input file is XLSX.
1082-
> * Document Intelligence v4.0 2024-11-30 (GA) supports bounding regions for figures and tables that cover only the core content and exclude associated caption and footnotes.
1082+
> * Table analysis isn't supported if the input file is XLSX.
1083+
> * Document Intelligence v4.0 `2024-11-30` (GA) supports bounding regions for figures and tables that cover only the core content and exclude associated caption and footnotes.
10831084
10841085
:::moniker-end
10851086

0 commit comments

Comments
 (0)