Skip to content

Commit 17adf99

Browse files
authored
Update concept-read.md
1 parent 613709d commit 17adf99

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

articles/ai-services/document-intelligence/concept-read.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Document Intelligence v4.0 (2023-10-31-preview) supports the following tools, ap
4848

4949
| Feature | Resources | Model ID |
5050
|----------|-------------|-----------|
51-
|**Read OCR model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|**prebuilt-read**|
51+
|**Read OCR model**|&bullet; [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|**prebuilt-read**|
5252
::: moniker-end
5353

5454
::: moniker range="doc-intel-3.1.0"
@@ -57,7 +57,7 @@ Document Intelligence v3.1 supports the following tools, applications, and libra
5757

5858
| Feature | Resources | Model ID |
5959
|----------|-------------|-----------|
60-
|**Read OCR model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)|**prebuilt-read**|
60+
|**Read OCR model**|&bullet; [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true)|**prebuilt-read**|
6161
::: moniker-end
6262

6363
::: moniker range="doc-intel-3.0.0"
@@ -66,7 +66,7 @@ Document Intelligence v3.0 supports the following tools, applications, and libra
6666

6767
| Feature | Resources | Model ID |
6868
|----------|-------------|-----------|
69-
|**Read OCR model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|**prebuilt-read**|
69+
|**Read OCR model**|&bullet; [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com)</br>&bullet; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|**prebuilt-read**|
7070
::: moniker-end
7171

7272
## Input requirements
@@ -99,17 +99,24 @@ Try extracting text from forms and documents using the Document Intelligence Stu
9999
:::image type="content" source="media/studio/run-analysis-analyze-options.png" alt-text="Screenshot of Run analysis and Analyze options buttons in the Document Intelligence Studio.":::
100100

101101
> [!div class="nextstepaction"]
102-
> [Try Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/layout).
102+
> [Try Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio/read).
103103
104104
## Supported languages and locales
105105

106-
*See* our [Language Support—document analysis models](language-support-ocr.md) page for a complete list of supported languages.
106+
See our [Language Support—document analysis models](language-support-ocr.md) page for a complete list of supported languages.
107107

108108
## Data extraction
109109

110+
> [!NOTE]
111+
> Microsoft Word and HTML file are supported in v3.1 and later versions. Compared with PDF and images, below features are not supported:
112+
> - There are no angle, width/height and unit with each page object.
113+
> - For each object detected, there is no bounding polygon or bounding region.
114+
> - Page range (`pages`) is not supported as a parameter.
115+
> - No `lines` object.
116+
110117
### Pages
111118

112-
The pages collection is the first object you see in the service response. The page units in the model output are computed as shown:
119+
The pages collection is a list of pages within the document. For each page, it is represented with the sequential number of the page within the document, the orientation angle, which could indicate if the page has been rotated, the width and height (dimentions in pixels) of the page. The page units in the model output are computed as shown:
113120

114121
**File format** | **Computed page unit** | **Total pages** |
115122
| --- | --- | --- |
@@ -131,8 +138,7 @@ The pages collection is the first object you see in the service response. The pa
131138
"unit": "pixel",
132139
"words": [],
133140
"lines": [],
134-
"spans": [],
135-
"kind": "document"
141+
"spans": []
136142
}
137143
]
138144
```
@@ -141,12 +147,9 @@ The pages collection is the first object you see in the service response. The pa
141147

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

144-
> [!NOTE]
145-
> For the Microsoft Word and HTML file support, the API ignores the pages parameter and extracts all pages by default.
146-
147150
### Paragraphs
148151

149-
The Read OCR model in Document Intelligence 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.
152+
The Read OCR model in Document Intelligence 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.
150153

151154
```json
152155
"paragraphs": [
@@ -162,7 +165,7 @@ The Read OCR model in Document Intelligence extracts all identified blocks of te
162165

163166
The Read OCR model extracts print and handwritten style text as `lines` and `words`. The model outputs bounding `polygon` coordinates and `confidence` for the extracted 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.md).
164167

165-
For Microsoft Word, Excel, PowerPoint, and HTML, Document Intelligence version 2023-10-31-preview the Read model extracts all embedded text as is. For embedded images, it uses OCR technology to extract text from each image and the extraction as an added entry to the `pages` collection. Added entries include the extracted text, lines, and words, their bounding polygons, confidences, and the spans pointing to the associated text.
168+
For Microsoft Word, Excel, PowerPoint, and HTML, Document Intelligence Read model v3.1 and later versions extracts all embedded text as is. Texts are extrated as words and paragraphs. Embedded images are not supported.
166169

167170

168171
```json
@@ -201,6 +204,8 @@ The response includes classifying whether each text line is of handwriting style
201204
}
202205
```
203206

207+
If you have turned on [font/style addon capability](concept-add-on-capabilities.md#font-property-extraction), you will also get the font/style result as part of the `styles` object.
208+
204209
## Next steps
205210

206211
Complete a Document Intelligence quickstart:
@@ -216,4 +221,4 @@ Complete a Document Intelligence quickstart:
216221
Explore our REST API:
217222

218223
> [!div class="nextstepaction"]
219-
> [Document Intelligence API v4.0](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)
224+
> [Document Intelligence API v4.0](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)

0 commit comments

Comments
 (0)