Skip to content

Commit 391ef99

Browse files
committed
edit 262602 for publication
1 parent 2d6ea36 commit 391ef99

14 files changed

+984
-986
lines changed

articles/ai-services/document-intelligence/choose-model-feature.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: overview
11-
ms.date: 11/15/2023
11+
ms.date: 01/19/2024
1212
ms.author: lajanuar
1313
---
1414

@@ -79,7 +79,7 @@ The following decision charts highlight the features of each **Document Intellig
7979

8080
| Training set | Example documents | Your best solution |
8181
| -----------------|--------------|-------------------|
82-
|**At least two different types of documents**. |Forms, leeter or documents | [**Custom classifiction model**](./concept-custom-classifier.md)|
82+
|**At least two different types of documents**. |Forms, letters, or documents | [**Custom classification model**](./concept-custom-classifier.md)|
8383

8484

8585

articles/ai-services/document-intelligence/concept-add-on-capabilities.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 11/21/2023
11+
ms.date: 01/19/2024
1212
ms.author: lajanuar
1313
monikerRange: '>=doc-intel-3.1.0'
1414
---
@@ -34,7 +34,7 @@ monikerRange: '>=doc-intel-3.1.0'
3434

3535
:::moniker range=">=doc-intel-3.1.0"
3636

37-
Document Intelligence supports more sophisticated and modular analysis capabilities. Use the add-on features to extend the results to include more features extracted from your documents. Some add-on features incur an extra cost. These optional features can be enabled and disabled depending on the scenario of the document extraction. To enable a feature simply add the associated feature name to the `features` query string property. You can enable more than one add-on feature on a request by providing a comma seperated list of features. The following add-on capabilities are available for `2023-07-31 (GA)` and later releases.
37+
Document Intelligence supports more sophisticated and modular analysis capabilities. Use the add-on features to extend the results to include more features extracted from your documents. Some add-on features incur an extra cost. These optional features can be enabled and disabled depending on the scenario of the document extraction. To enable a feature, add the associated feature name to the `features` query string property. You can enable more than one add-on feature on a request by providing a comma-separated list of features. The following add-on capabilities are available for `2023-07-31 (GA)` and later releases.
3838

3939
* [`ocrHighResolution`](#high-resolution-extraction)
4040

@@ -66,7 +66,7 @@ The following add-on capability is available for `2023-10-31-preview` and later
6666
6767
::: moniker-end
6868

69-
|Add-on Capability| Add-On/Free|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)|
69+
|Add-on Capability| Add-On/Free|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[`2023-07-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[`2022-08-31` (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)|
7070
|----------------|-----------|---|--|---|---|
7171
|Font property extraction|Add-On| ✔️| ✔️| n/a| n/a|
7272
|Formula extraction|Add-On| ✔️| ✔️| n/a| n/a|
@@ -77,7 +77,7 @@ The following add-on capability is available for `2023-10-31-preview` and later
7777
|Query fields|Add-On*| ✔️|n/a|n/a| n/a|
7878

7979

80-
Add-On* - Query fields are priced differently than the other add on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details.
80+
Add-On* - Query fields are priced differently than the other add-on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details.
8181

8282
## High resolution extraction
8383

@@ -235,7 +235,7 @@ https://{your resource}.cognitiveservices.azure.com/formrecognizer/documentModel
235235

236236
## Language detection
237237

238-
Adding the `languages` feature to the analyze request predicts the detected primary language for each text line along with the `confidence` in the `languages` collection under `analyzeResult`.
238+
Adding the `languages` feature to the `analyzeResult` request predicts the detected primary language for each text line along with the `confidence` in the `languages` collection under `analyzeResult`.
239239

240240
```json
241241
"languages": [
@@ -270,7 +270,7 @@ https://{your resource}.cognitiveservices.azure.com/formrecognizer/documentModel
270270

271271
## Key-value Pairs
272272

273-
In earlier API versions the prebuilt-document model extracted keyvalue pairs from forms and documents. With the addition of the `keyValuePairs` feature to prebuilt-layout, the layout model now produces the same results.
273+
In earlier API versions, the prebuilt-document model extracted key-value pairs from forms and documents. With the addition of the `keyValuePairs` feature to prebuilt-layout, the layout model now produces the same results.
274274

275275
Key-value pairs are specific spans within the document that identify a label or key and its associated response or value. In a structured form, these pairs could be the label and the value the user entered for that field. In an unstructured document, they could be the date a contract was executed on based on the text in a paragraph. The AI model is trained to extract identifiable keys and values based on a wide variety of document types, formats, and structures.
276276

@@ -282,10 +282,9 @@ Keys can also exist in isolation when the model detects that a key exists, with
282282
https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=keyValuePairs
283283
```
284284

285-
286285
## Query Fields
287286

288-
Query fields is an add-on capability to extend the schema extracted from any prebuilt model or define a specific key name when the key name is variable. To use query fields, set the features to `queryFields` and provide a comma seperated list of field names in the `queryFields` property.
287+
Query fields are an add-on capability to extend the schema extracted from any prebuilt model or define a specific key name when the key name is variable. To use query fields, set the features to `queryFields` and provide a comma-separated list of field names in the `queryFields` property.
289288

290289
* Document Intelligence now supports query field extractions. With query field extraction, you can add fields to the extraction process using a query request without the need for added training.
291290

articles/ai-services/document-intelligence/concept-composed-models.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 11/21/2023
11+
ms.date: 01/19/2024
1212
ms.author: lajanuar
1313
---
1414

@@ -34,7 +34,7 @@ ms.author: lajanuar
3434

3535
**Composed models**. A composed model is created by taking a collection of custom models and assigning them to a single model built from your form types. When a document is submitted for analysis using a composed model, the service performs a classification to decide which custom model best represents the submitted document.
3636

37-
With composed models, you can assign multiple custom models to a composed model called with a single model ID. It's useful when you've trained several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction.
37+
With composed models, you can assign multiple custom models to a composed model called with a single model ID. It's useful when you train several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction.
3838

3939
* ```Custom form``` and ```Custom template``` models can be composed together into a single composed model.
4040

articles/ai-services/document-intelligence/concept-custom-classifier.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: vkurpad
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 11/21/2023
9+
ms.date: 01/19/2024
1010
ms.author: lajanuar
1111
ms.custom:
1212
- references_regions
@@ -107,23 +107,23 @@ Classification models can now be trained on documents of different languages. Se
107107

108108
* For custom classification model training, the total size of training data is `1GB` with a maximum of 10,000 pages.
109109

110-
111110
## Document splitting
112111

113-
When you have more than one document in a file, the classifier can identify the different document types contained within the input file. The classifier response will contain the page ranges for each of the identified document types contined within a file. This can include multiple instances of the same document type.
112+
When you have more than one document in a file, the classifier can identify the different document types contained within the input file. The classifier response contains the page ranges for each of the identified document types contained within a file. This response can include multiple instances of the same document type.
114113

115114
::: moniker range=">=doc-intel-4.0.0"
116-
The analyze operation now includes a `splitMode` property that gives you granular control over the splitting behavior.
117-
* To trat the entire input file as a single document for classification set the splitMode to `none`. When you do this, the service returns just one class for the entire input file.
118-
* To classify each page of the input file, set the splitMode to `perPage`. The service will attept to classify each page as an individual document.
119-
* Set the splitMode to `auto` and the service will identify the documents and associated page ranges.
115+
The analyze operation now includes a `splitMode` property that gives you granular control over the splitting behavior.
116+
117+
* To treat the entire input file as a single document for classification set the splitMode to `none`. When you do so, the service returns just one class for the entire input file.
118+
* To classify each page of the input file, set the splitMode to `perPage`. The service attempts to classify each page as an individual document.
119+
* Set the splitMode to `auto` and the service identifies the documents and associated page ranges.
120120
::: moniker-end
121121

122122
## Best practices
123123

124124
Custom classification models require a minimum of five samples per class to train. If the classes are similar, adding extra training samples improves model accuracy.
125125

126-
The classifier will attempt to assign each document to one of the classes, if you expect the model will see document types not in the classes that are part of the training dataset, you should plan to set a threshold on the classification score or add a few representative samples of the document types to an ```"other"``` class. Adding an ```"other"``` class will ensure that the documents not needed do not impact your classifier quality.
126+
The classifier attempts to assign each document to one of the classes, if you expect the model to see document types not in the classes that are part of the training dataset, you should plan to set a threshold on the classification score or add a few representative samples of the document types to an ```"other"``` class. Adding an ```"other"``` class ensures that unneeded documents don't impact your classifier quality.
127127

128128
## Training a model
129129

articles/ai-services/document-intelligence/concept-custom-label.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: 11/21/2023
9+
ms.date: 01/19/2024
1010
ms.author: vikurpad
1111
ms.custom:
1212
- references_regions

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 11/21/2023
11+
ms.date: 01/19/2024
1212
ms.author: lajanuar
1313
monikerRange: '>=doc-intel-3.0.0'
1414
---
@@ -31,12 +31,13 @@ monikerRange: '>=doc-intel-3.0.0'
3131
::: moniker-end
3232

3333
[Document Intelligence Studio](https://documentintelligence.ai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Document Intelligence service into your applications. Use the Document Intelligence Studio to:
34+
3435
* Learn more about the different capabilities in Document Intelligence.
3536
* Use your Document Intelligence resource to test models on sample documents or upload your own documents.
3637
* Experiment with different add-on and preview features to adapt the output to your needs.
37-
* Train custom classifcation models to classify documents.
38+
* Train custom classification models to classify documents.
3839
* Train custom extraction models to extract fields from documents.
39-
* Get sample code for the language spcific SDKs to integrate into y9our applications.
40+
* Get sample code for the language-specific SDKs to integrate into your applications.
4041

4142
Use the [Document Intelligence Studio quickstart](quickstarts/try-document-intelligence-studio.md) to get started analyzing documents with document analysis or prebuilt models. Build custom models and reference the models in your applications using one of the [language specific SDKs](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) and other quickstarts.
4243

@@ -46,7 +47,7 @@ The following image shows the landing page for Document Intelligence Studio.
4647

4748
## Getting started
4849

49-
If this is the first time you are visiting the Studio, follow the [getting started guide](studio-overview.md#get-started-using-document-intelligence-studio) to setup the Studio for use.
50+
If you're visiting the Studio for the first time, follow the [getting started guide](studio-overview.md#get-started-using-document-intelligence-studio) to set up the Studio for use.
5051

5152
## Analyze options
5253

articles/ai-services/document-intelligence/concept-model-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 11/21/2023
11+
ms.date: 01/19/2024
1212
ms.author: lajanuar
1313
---
1414

@@ -45,7 +45,7 @@ ms.author: lajanuar
4545

4646
The following table shows the available models for each current preview and stable API:
4747

48-
|Model Type| Model|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)|
48+
|**Model Type**| **Model**|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)|
4949
|----------------|-----------|---|--|---|---|
5050
|Document analysis models|[Read](concept-read.md) | ✔️| ✔️| ✔️| n/a|
5151
|Document analysis models|[Layout](concept-layout.md) | ✔️| ✔️| ✔️| ✔️|
@@ -67,7 +67,7 @@ The following table shows the available models for each current preview and stab
6767
|Custom models|[Custom template](concept-custom-template.md) | ✔️| ✔️| ✔️| ✔️|
6868
|Custom models|[Custom composed](concept-composed-models.md) | ✔️| ✔️| ✔️| ✔️|
6969

70-
|Add-on Capability| Add-On/Free|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)|
70+
|**Add-on Capability**| **Add-On/Free**|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[`2023-07-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[`2022-08-31` (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)|
7171
|----------------|-----------|---|--|---|---|
7272
|Font property extraction|Add-On| ✔️| ✔️| n/a| n/a|
7373
|Formula extraction|Add-On| ✔️| ✔️| n/a| n/a|
@@ -78,7 +78,7 @@ The following table shows the available models for each current preview and stab
7878
|Query fields|Add-On*| ✔️|n/a|n/a| n/a|
7979

8080

81-
Add-On* - Query fields are priced differently than the other add on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details.
81+
Add-On* - Query fields are priced differently than the other add-on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details.
8282

8383
::: moniker range=">=doc-intel-3.0.0"
8484

0 commit comments

Comments
 (0)