update read

Author: laujan

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

@@ -26,7 +26,7 @@ ms.author: lajanuar
 
 > [!NOTE]
 >
-> For extracting text from external images like labels, street signs, and posters, use the [Azure AI Image Analysis v4.0 Read](../../Computer-vision/concept-ocr.md) feature optimized for general, non-document images with a performance-enhanced synchronous API that makes it easier to embed OCR in real-time user experience scenarios.
+> To extract text from external images like labels, street signs, and posters, use the [Azure AI Image Analysis v4.0 Read](../../Computer-vision/concept-ocr.md) feature optimized for general (not document) images with a performance-enhanced synchronous API. This capability makes it easier to embed OCR in real-time user experience scenarios.
 >
 
 Document Intelligence Read Optical Character Recognition (OCR) model runs at a higher resolution than Azure AI Vision Read and extracts print and handwritten text from PDF documents and scanned images. It also includes support for extracting text from Microsoft Word, Excel, PowerPoint, and HTML documents. It detects paragraphs, text lines, words, locations, and languages. The Read model is the underlying OCR engine for other Document Intelligence prebuilt models like Layout, General Document, Invoice, Receipt, Identity (ID) document, Health insurance card, W2 in addition to custom models.
@@ -83,11 +83,11 @@ See our [Language Support—document analysis models](../language-support/ocr.md
 ## Data extraction (v4)
 
 > [!NOTE]
-> Microsoft Word and HTML file are supported in v4.0. Compared with PDF and images, below features are not supported:
+> Microsoft Word and HTML file are supported in v4.0. The following capabilities are currently not supported:
 >
-> * There are no angle, width/height and unit with each page object.
-> * For each object detected, there is no bounding polygon or bounding region.
-> * Page range (`pages`) is not supported as a parameter.
+> * No angle, width/height, and unit returned with each page object.
+> * No bounding polygon or bounding region for each object detected.
+> * No page range (`pages`) as a parameter returned.
 > * No `lines` object.
 
 ## Searchable PDFs
@@ -96,8 +96,8 @@ The searchable PDF capability enables you to convert an analog PDF, such as scan
 
   > [!IMPORTANT]
   >
-  > * Currently, the searchable PDF capability is only supported by Read OCR model `prebuilt-read`. When using this feature, please specify the `modelId` as `prebuilt-read`, as other model types will return error for this preview version.
-  > * Searchable PDF is included with the 2024-11-30 GA `prebuilt-read` model with no additional cost for generating a searchable PDF output.
+  > * Currently, only  the Read OCR model `prebuilt-read` supports the searchable PDF capability. When using this feature, specify the `modelId` as `prebuilt-read`. Other model types return an error for this preview version.
+  > * Searchable PDF is included with the `2024-11-30` GA `prebuilt-read` model with no added cost for generating a searchable PDF output.
 
 ### Use searchable PDFs
 
@@ -124,41 +124,41 @@ Upon successful completion, the PDF can be retrieved and downloaded as `applicat
      // Upon successful completion, retrieve the PDF as application/pdf.
      GET {endpoint}/documentintelligence/documentModels/prebuilt-read/analyzeResults/{resultId}/pdf?api-version=2024-11-30
 URI Parameters
-Name	In	Required	Type	Description
-endpoint	path	True	
+Name    In    Required    Type    Description
+endpoint    path    True    
 string
 
-uri	
+uri    
 The Document Intelligence service endpoint.
 
-modelId	path	True	
+modelId    path    True    
 string
 
 Unique document model name.
 
 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
 
-resultId	path	True	
+resultId    path    True    
 string
 
-uuid	
+uuid    
 Analyze operation result ID.
 
-api-version	query	True	
+api-version    query    True    
 string
 
 The API version to use for this operation.
 
 Responses
-Name	Type	Description
-200 OK	
+Name    Type    Description
+200 OK    
 file
 
 The request has succeeded.
 
 Media Types: "application/pdf", "application/json"
 
-Other Status Codes	
+Other Status Codes    
 DocumentIntelligenceErrorResponse
 
 An unexpected error response.
@@ -177,8 +177,8 @@ Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
 Token URL: https://login.microsoftonline.com/common/oauth2/token
 
 Scopes
-Name	Description
-https://cognitiveservices.azure.com/.default	
+Name    Description
+https://cognitiveservices.azure.com/.default    
 Examples
 Get Analyze Document Result PDF
 Sample request
@@ -195,69 +195,69 @@ JSON
 Copy
 "{pdfBinary}"
 Definitions
-Name	Description
-DocumentIntelligenceError	
+Name    Description
+DocumentIntelligenceError    
 The error object.
 
-DocumentIntelligenceErrorResponse	
+DocumentIntelligenceErrorResponse    
 Error response object.
 
-DocumentIntelligenceInnerError	
+DocumentIntelligenceInnerError    
 An object containing more specific information about the error.
 
 DocumentIntelligenceError
 The error object.
 
-Name	Type	Description
-code	
+Name    Type    Description
+code    
 string
 
 One of a server-defined set of error codes.
 
-details	
+details    
 DocumentIntelligenceError[]
 
 An array of details about specific errors that led to this reported error.
 
-innererror	
+innererror    
 DocumentIntelligenceInnerError
 
 An object containing more specific information than the current object about the error.
 
-message	
+message    
 string
 
 A human-readable representation of the error.
 
-target	
+target    
 string
 
 The target of the error.
 
 DocumentIntelligenceErrorResponse
 Error response object.
 
-Name	Type	Description
-error	
+Name    Type    Description
+error    
 DocumentIntelligenceError
 
 Error info.
 
 DocumentIntelligenceInnerError
 An object containing more specific information about the error.
 
-Name	Type	Description
-code	
+Name    Type    Description
+code    
 string
 
 One of a server-defined set of error codes.
 
-innererror	
+innererror    
 DocumentIntelligenceInnerError
 
 Inner error.
 
-message	
+message    
 string
 
 A human-readable representation of the error.
@@ -439,7 +439,7 @@ Find more samples on GitHub:
 
 > [!NOTE]
 >
-> For extracting text from external images like labels, street signs, and posters, use the [Azure AI Image Analysis v4.0 Read](../..//Computer-vision/concept-ocr.md) feature optimized for general, non-document images with a performance-enhanced synchronous API that makes it easier to embed OCR in your user experience scenarios.
+> To extract text from external images like labels, street signs, and posters, use the [Azure AI Image Analysis v4.0 Read](../../Computer-vision/concept-ocr.md) feature optimized for general (not document) images with a performance-enhanced synchronous API. This capability makes it easier to embed OCR in real-time user experience scenarios.
 >
 
 Document Intelligence Read Optical Character Recognition (OCR) model runs at a higher resolution than Azure AI Vision Read and extracts print and handwritten text from PDF documents and scanned images. It also includes support for extracting text from Microsoft Word, Excel, PowerPoint, and HTML documents. It detects paragraphs, text lines, words, locations, and languages. The Read model is the underlying OCR engine for other Document Intelligence prebuilt models like Layout, General Document, Invoice, Receipt, Identity (ID) document, Health insurance card, W2 in addition to custom models.
@@ -513,11 +513,11 @@ See our [Language Support—document analysis models](../language-support/ocr.md
 ## Data extraction
 
 > [!NOTE]
-> Microsoft Word and HTML file are supported in v3.1 and later versions. Compared with PDF and images, below features are not supported:
+> Microsoft Word and HTML file are supported in v4.0. The following capabilities are currently not supported:
 >
-> * There are no angle, width/height and unit with each page object.
-> * For each object detected, there is no bounding polygon or bounding region.
-> * Page range (`pages`) is not supported as a parameter.
+> * No angle, width/height, and unit returned with each page object.
+> * No bounding polygon or bounding region for each object detected.
+> * No page range (`pages`) as a parameter returned.
 > * No `lines` object.
 
 ## Searchable PDF
@@ -526,9 +526,9 @@ The searchable PDF capability enables you to convert an analog PDF, such as scan
 
   > [!IMPORTANT]
   >
-  > * Currently, the searchable PDF capability is only supported by Read OCR model `prebuilt-read`. When using this feature, please specify the `modelId` as `prebuilt-read`, as other model types will return an error.
-  > * Searchable PDF is included with the 2024-11-30 `prebuilt-read` model with no additional cost for generating a searchable PDF output.
->   * Searchable PDF currently only supports PDF files as input. Support for other file types, such as image files, will be available later.
+  > * Currently, only Read OCR model `prebuilt-read` supports the searchable PDF capability. When using this feature, specify the `modelId` as `prebuilt-read`. Other model types return an error.
+  > * Searchable PDF is included with the `2024-11-30` `prebuilt-read` model with no added cost for generating a searchable PDF output.
+>   * Searchable PDF currently only supports PDF files as input. 
 
 ### Use searchable PDF