Skip to content

Commit bc1d0aa

Browse files
committed
resolve moniker issues
1 parent c94830a commit bc1d0aa

File tree

1 file changed

+32
-22
lines changed
  • articles/ai-services/document-intelligence/prebuilt

1 file changed

+32
-22
lines changed

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

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ See how data, including text, tables, table headers, selection marks, and struct
9191
### [REST API](#tab/rest)
9292

9393
* [Document Intelligence REST API](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true&tabs=HTTP&)
94-
9594
* [How to guide](../how-to-guides/use-sdk-rest-api.md#use-document-intelligence-models)
95+
9696
# [Client libraries](#tab/sdks)
9797

9898
* [**C# SDK**](../quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#layout-model)
@@ -103,14 +103,22 @@ See how data, including text, tables, table headers, selection marks, and struct
103103
### [Document Intelligence Studio](#tab/studio)
104104

105105
* [Studio](https://documentintelligence.ai.azure.com/studio)
106-
107106
* [How-to guide](../studio-overview.md#authentication-in-studio)
108107

109108
---
110109

111110
## Data extraction
112111

113-
The layout model extracts text, selection marks, tables, paragraphs, and paragraph types (`roles`) from your documents.
112+
The layout model extracts text, selection marks, tables, paragraphs, and paragraph types (`roles`) from your documents. To follow are descriptions of page layout structural elements with guidance on how to extract them:
113+
114+
* [**Pages**](#pages)
115+
* [**Paragraphs**](#paragraphs)
116+
* [**Text, lines, and words**](#text-lines-and-words)
117+
* [**Handwritten style**](#handwritten-style-for-text-lines)
118+
* [**Selection marks**](#selection-marks)
119+
* [**Tables**](#tables)
120+
* [**Figures**](#figures)
121+
* [**Sections**](#sections)
114122

115123
### Pages
116124

@@ -158,7 +166,7 @@ print(f"Page has width: {page.width} and height: {page.height}, measured with un
158166

159167
---
160168

161-
### Extract selected pages from documents
169+
#### Extract selected pages
162170

163171
For large multi-page documents, use the `pages` query parameter to indicate specific page numbers or page ranges for text extraction.
164172

@@ -177,7 +185,7 @@ The Layout model extracts all identified blocks of text in the `paragraphs` coll
177185
]
178186
```
179187

180-
### Paragraph roles
188+
#### Paragraph roles
181189

182190
The new machine-learning based page object detection extracts logical roles like titles, section headings, page headers, page footers, and more. The Document Intelligence Layout model assigns certain text blocks in the `paragraphs` collection with their specialized role or type predicted by the model. It's best to use paragraph roles with unstructured documents to help understand the layout of the extracted content for a richer semantic analysis. The following paragraph roles are supported:
183191

@@ -582,7 +590,11 @@ The following illustration shows the typical components in an image of a sample
582590

583591
:::image type="content" source="../media/document-layout-example-new.png" alt-text="Illustration of document layout example.":::
584592

585-
## Development options
593+
## Supported languages and locales
594+
595+
*See* our [Language Support—document analysis models](../language-support/ocr.md) page for a complete list of supported languages.
596+
597+
## Tool and development options
586598

587599
:::moniker-end
588600

@@ -616,16 +628,18 @@ Document Intelligence v2.1 supports the following tools, applications, and libra
616628

617629
:::moniker-end
618630

619-
## Input guidance
620-
621631
:::moniker range="doc-intel-3.1.0 || doc-intel-3.0.0"
622632

633+
## Input guidance
634+
623635
[!INCLUDE [input requirements](./../includes/input-requirements.md)]
624636

625637
:::moniker-end
626638

627639
:::moniker range="doc-intel-2.1.0"
628640

641+
## Input guide
642+
629643
* Supported file formats: JPEG, PNG, PDF, and TIFF.
630644
* Supported number of pages: For PDF and TIFF, up to 2,000 pages are processed. For free tier subscribers, only the first two pages are processed.
631645
* Supported file size: the file size must be less than 50 MB and dimensions at least 50 x 50 pixels and at most 10,000 x 10,000 pixels.
@@ -634,7 +648,7 @@ Document Intelligence v2.1 supports the following tools, applications, and libra
634648

635649
:::moniker range="<=doc-intel-3.1.0"
636650

637-
### Get started with Layout model
651+
### Get started
638652

639653
See how data, including text, tables, table headers, selection marks, and structure information is extracted from documents using Document Intelligence. You need the following resources:
640654

@@ -698,10 +712,6 @@ See how data, including text, tables, table headers, selection marks, and struct
698712

699713
:::moniker-end
700714

701-
## Supported languages and locales
702-
703-
*See* our [Language Support—document analysis models](../language-support/ocr.md) page for a complete list of supported languages.
704-
705715
:::moniker range="doc-intel-2.1.0"
706716

707717
Document Intelligence v2.1 supports the following tools, applications, and libraries:
@@ -714,7 +724,7 @@ Document Intelligence v2.1 supports the following tools, applications, and libra
714724

715725
:::moniker range="<=doc-intel-3.1.0"
716726

717-
## Data extraction
727+
## Extract data
718728

719729
The layout model extracts text, selection marks, tables, paragraphs, and paragraph types (`roles`) from your documents.
720730

@@ -726,7 +736,7 @@ The layout model extracts text, selection marks, tables, paragraphs, and paragra
726736
> * Page range (`pages`) is not supported as a parameter.
727737
> * No `lines` object.
728738

729-
### Pages
739+
### Page
730740

731741
The pages collection is a list of pages within the document. Each page is represented sequentially within the document and ../includes the orientation angle indicating if the page is rotated and the width and height (dimensions in pixels). The page units in the model output are computed as shown:
732742

@@ -804,7 +814,7 @@ for page in result.pages:
804814

805815
For large multi-page documents, use the `pages` query parameter to indicate specific page numbers or page ranges for text extraction.
806816

807-
### Paragraphs
817+
### Paragraph
808818

809819
The Layout model extracts all identified blocks of text in the `paragraphs` collection as a top level object under `analyzeResults`. Each entry in this collection represents a text block and ../includes the extracted text as`content`and the bounding `polygon` coordinates. The `span` information points to the text fragment within the top level `content` property that contains the full text from the document.
810820

@@ -819,7 +829,7 @@ The Layout model extracts all identified blocks of text in the `paragraphs` coll
819829
]
820830
```
821831

822-
### Paragraph roles
832+
#### Paragraph role
823833

824834
The new machine-learning based page object detection extracts logical roles like titles, section headings, page headers, page footers, and more. The Document Intelligence Layout model assigns certain text blocks in the `paragraphs` collection with their specialized role or type predicted by the model. It's best to use paragraph roles with unstructured documents to help understand the layout of the extracted content for a richer semantic analysis. The following paragraph roles are supported:
825835

@@ -852,7 +862,7 @@ The new machine-learning based page object detection extracts logical roles like
852862

853863
```
854864

855-
### Text, lines, and words
865+
### Text, line, and word
856866

857867
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).
858868

@@ -931,7 +941,7 @@ for line_idx, line in enumerate(page.lines):
931941

932942
:::moniker range="<=doc-intel-3.1.0"
933943

934-
### Handwritten style for text lines
944+
### Handwritten style
935945

936946
The response ../includes classifying whether each text line is of handwriting style or not, along with a confidence score. For more information. See [Handwritten language support](../language-support/ocr.md). The following example shows an example JSON snippet.
937947

@@ -951,7 +961,7 @@ The response ../includes classifying whether each text line is of handwriting st
951961

952962
If you enable the [font/style addon capability](../concept-add-on-capabilities.md#font-property-extraction), you also get the font/style result as part of the `styles` object.
953963

954-
### Selection marks
964+
### Selection mark
955965

956966
The Layout model also extracts selection marks from documents. Extracted selection marks appear within the `pages` collection for each page. They include the bounding `polygon`, `confidence`, and selection `state` (`selected/unselected`). The text representation (that is, `:selected:` and `:unselected`) is also included as the starting index (`offset`) and `length` that references the top level `content` property that contains the full text from the document.
957967

@@ -1017,7 +1027,7 @@ for selection_mark in page.selection_marks:
10171027

10181028
:::moniker range="<=doc-intel-3.1.0"
10191029

1020-
### Tables
1030+
### Table
10211031

10221032
Extracting tables is a key requirement for processing documents containing large volumes of data typically formatted as tables. The Layout model extracts tables in the `pageResults` section of the JSON output. Extracted table information ../includes the number of columns and rows, row span, and column span. Each cell with its bounding polygon is output along with information whether the area is recognized as a `columnHeader` or not. The model supports extracting tables that are rotated. Each table cell contains the row and column index and bounding polygon coordinates. For the cell text, the model outputs the `span` information containing the starting index (`offset`). The model also outputs the `length` within the top-level content that contains the full text from the document.
10231033

@@ -1200,7 +1210,7 @@ Layout API extracts tables in the `pageResults` section of the JSON output. Docu
12001210

12011211
![Tables example](../media/layout-table-header-demo.gif)
12021212

1203-
### Selection marks
1213+
### Selection marks (documents)
12041214

12051215
Layout API also extracts selection marks from documents. Extracted selection marks include the bounding box, confidence, and state (selected/unselected). Selection mark information is extracted in the `readResults` section of the JSON output.
12061216

0 commit comments

Comments
 (0)