You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/document-intelligence/concept/markdown-elements.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
-
title: Document Intelligence supported markdown elements
2
+
title: Document Intelligence supported Markdown elements
3
3
titleSuffix: Azure AI services
4
-
description: Description of the supported markdown elements returned as part of the Layout API response and how to use the response in your applications.
4
+
description: Description of the supported Markdown elements returned as part of the Layout API response and how to use the response in your applications.
5
5
author: laujan
6
6
manager: nitinme
7
7
ms.service: azure-ai-document-intelligence
@@ -13,14 +13,14 @@ ms.author: tonyeiyalla
13
13
14
14
# Understanding Document Intelligence Layout API Markdown Output Format
15
15
16
-
Azure AI Document Intelligence Layout API can transform your documents into rich markdown, preserving their original structure and formatting. Just specify `outputContentFormat=markdown` in your request to receive semantically structured content that maintains paragraphs, headings, tables, and other document elements in their proper hierarchy.
16
+
Azure AI Document Intelligence Layout API can transform your documents into rich Markdown, preserving their original structure and formatting. Just specify `outputContentFormat=markdown` in your request to receive semantically structured content that maintains paragraphs, headings, tables, and other document elements in their proper hierarchy.
17
17
18
-
This markdown output elegantly captures the document's original organization while providing standardized, easily consumable content for downstream applications. The preserved semantic structure enables more sophisticated document processing workflows without losing the context and relationships between document elements.
18
+
This Markdown output elegantly captures the document's original organization while providing standardized, easily consumable content for downstream applications. The preserved semantic structure enables more sophisticated document processing workflows without losing the context and relationships between document elements.
19
19
20
20
21
21
## Markdown elements supported in Layout Analysis
22
22
23
-
The following markdown elements are included in Layout API responses:
23
+
The following Markdown elements are included in Layout API responses:
24
24
25
25
* Paragraph
26
26
* Heading
@@ -46,7 +46,7 @@ Here's an example:
46
46
47
47
```md
48
48
This is paragraph 1.
49
-
This is still paragraph 1, even if in another markdown line.
49
+
This is still paragraph 1, even if in another Markdown line.
50
50
51
51
This is paragraph 2. There is a blank line between paragraph 1 and paragraph 2.
52
52
```
@@ -56,7 +56,7 @@ This is paragraph 2. There is a blank line between paragraph 1 and paragraph 2.
56
56
57
57
Headings organize document content into a hierarchical structure to make navigation and understanding easier. The Layout API has the following capabilities:
58
58
59
-
* Uses standard markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels.
59
+
* Uses standard Markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels.
60
60
* Maintains proper spacing with two blank lines before each heading for improved readability.
61
61
62
62
Here's an example:
@@ -77,7 +77,7 @@ Here's an example:
77
77
78
78
Tables preserve complex structured data in a visually organized format. The Layout API uses HTML table syntax for maximum fidelity and compatibility:
79
79
80
-
* Implements full HTML table markup (`<table>`, `<tr>`, `<th>`, `<td>`) rather than standard markdown tables
80
+
* Implements full HTML table markup (`<table>`, `<tr>`, `<th>`, `<td>`) rather than standard Markdown tables
81
81
* Preserves merged cell with HTML rowspan and colspan attributes.
82
82
* Preserves table captions with the `<caption>` tag to maintain document context
83
83
* Handles complex table structures including headers, cells, and footers
@@ -160,9 +160,9 @@ $$= \exp \left[ - \sum _ { k = 1 } ^ { j - 1 } \beta _ { k , k + 1 } \Delta E _
160
160
161
161
### Barcode
162
162
163
-
Barcodes and QR codes are represented using markdown image syntax with added semantic information:
163
+
Barcodes and QR codes are represented using Markdown image syntax with added semantic information:
164
164
165
-
* Uses standard image markdown syntax with descriptive attributes
165
+
* Uses standard image Markdown syntax with descriptive attributes
166
166
* Captures both the barcode type (QR code, barcode, etc.) and its encoded value
167
167
* Preserves the semantic relationship between barcodes and surrounding content
168
168
@@ -181,7 +181,7 @@ Here's an example:
181
181
182
182
Page metadata elements provide context about document pagination but aren't meant to be displayed inline with the main content:
183
183
184
-
* Enclosed in HTML comments to preserve the information while keeping it hidden from standard markdown rendering
184
+
* Enclosed in HTML comments to preserve the information while keeping it hidden from standard Markdown rendering
185
185
* Maintains original page structure information that might be valuable for document reconstruction
186
186
* Enables applications to understand document pagination without disrupting the content flow
187
187
@@ -211,7 +211,8 @@ Here's an example:
211
211
For KeyValuePairs/Language/Style, we map them to Analytics JSON body and not in the Markdown content.
> For more information on Markdown that is currently supported for user content on GitHub.com, *see*[GitHub Flavored Markdown Spec](https://github.github.com/gfm).
0 commit comments