Skip to content

Commit d3466c5

Browse files
committed
new markdown response article
1 parent 8b3bef3 commit d3466c5

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

articles/ai-services/document-intelligence/concept/markdown-elements.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: Document Intelligence Supported Markdown Elements
2+
title: Document Intelligence supported markdown elements
33
titleSuffix: Azure AI services
44
description: Description of the supported markdown elements returned as part of the Layout API response and how to use the response in your applications.
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 04/24/2025
9+
ms.date: 05/05/2025
1010
ms.author: tonyeiyalla
1111

1212
---
1313

1414
# Understanding Document Intelligence Layout API Markdown Output Format
1515

16-
Azure AI Document Intelligence's Layout API can transform your documents into rich markdown, preserving their original structure and formatting. Simply 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.
1717

1818
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.
1919

@@ -42,7 +42,7 @@ Paragraphs represent cohesive blocks of text that belong together semantically.
4242
* Using line breaks within paragraphs to maintain the visual structure of the original document
4343
* Maintaining proper text flow that respects the original document's reading order
4444

45-
Here is an example:
45+
Here's an example:
4646

4747
``` md
4848
This is paragraph 1.
@@ -54,12 +54,12 @@ This is paragraph 2. There is a blank line between paragraph 1 and paragraph 2.
5454

5555
### Heading
5656

57-
Headings organize document content into a hierarchical structure, making navigation and understanding easier. The Layout API:
57+
Headings organize document content into a hierarchical structure to make navigation and understanding easier. The Layout API has the following capabilities:
5858

59-
* Uses standard markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels
60-
* Maintains proper spacing with two blank lines before each heading for improved readability
59+
* Uses standard markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels.
60+
* Maintains proper spacing with two blank lines before each heading for improved readability.
6161

62-
Here is an example:
62+
Here's an example:
6363

6464
``` md
6565
# This is a title
@@ -84,7 +84,7 @@ Tables preserve complex structured data in a visually organized format. The Layo
8484
* Maintains proper spacing with two blank lines before each table for improved readability
8585
* Preserves table footnotes as separate paragraph following the table
8686

87-
Here is an example:
87+
Here's an example:
8888

8989
``` md
9090
<table>
@@ -108,7 +108,7 @@ The Layout API preserves figure elements:
108108
* Preserves figure captions with the `<figcaption>` tag to provide important context
109109
* Preserves figure footnotes as separate paragraphs following the figure container
110110

111-
Here is an example:
111+
Here's an example:
112112

113113
``` md
114114
<figure>
@@ -146,7 +146,7 @@ Mathematical formulas are preserved with LaTeX-compatible syntax that allows for
146146
* Multi-line formulas are represented as consecutive block formulas, preserving mathematical relationships
147147
* Original spacing and formatting are maintained to ensure accurate representation
148148

149-
Here is an example of inline formula, single-line formula block and multiple-lines formula block:
149+
Here's an example of inline formula, single-line formula block and multiple-lines formula block:
150150

151151
``` md
152152
The mass-energy equivalence formula $E = m c ^ { 2 }$ is an example of an inline formula
@@ -160,13 +160,13 @@ $$= \exp \left[ - \sum _ { k = 1 } ^ { j - 1 } \beta _ { k , k + 1 } \Delta E _
160160

161161
### Barcode
162162

163-
Barcodes and QR codes are represented using markdown image syntax with additional semantic information:
163+
Barcodes and QR codes are represented using markdown image syntax with added semantic information:
164164

165165
* Uses standard image markdown syntax with descriptive attributes
166166
* Captures both the barcode type (QR code, barcode, etc.) and its encoded value
167167
* Preserves the semantic relationship between barcodes and surrounding content
168168

169-
Here is an example:
169+
Here's an example:
170170

171171
```
172172
![QRCode](barcodes/1.1 "https://www.microsoft.com")
@@ -185,7 +185,7 @@ Page metadata elements provide context about document pagination but aren't mean
185185
* Maintains original page structure information that might be valuable for document reconstruction
186186
* Enables applications to understand document pagination without disrupting the content flow
187187

188-
Here is an example:
188+
Here's an example:
189189

190190
``` md
191191
<!-- PageHeader="This is page header" -->
@@ -200,7 +200,7 @@ Here is an example:
200200

201201
To easily figure out which parts belong to which page base on the pure Markdown content, we introduced PageBreak as the delimiter of the pages
202202

203-
Here is an example:
203+
Here's an example:
204204
``` md
205205
<!-- PageBreak -->
206206
```

articles/ai-services/document-intelligence/prebuilt/layout.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: conceptual
9-
ms.date: 04/23/2025
9+
ms.date: 05/05/2025
1010
ms.author: lajanuar
1111
---
1212

articles/ai-services/document-intelligence/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ items:
153153
- name: Analyze document API response
154154
displayName: words, lines, pages, bounding regions, documents
155155
href: concept/analyze-document-response.md
156-
- name: Layout API Markdown Output Elements
156+
- name: Layout API markdown output elements
157157
displayName: words, lines, pages, bounding regions, documents
158158
href: concept/markdown-elements.md
159159
- name: Retrieval-Augmented Generation (RAG)

0 commit comments

Comments
 (0)