Skip to content

Commit 35ecf37

Browse files
committed
vinod updates
1 parent 0a33239 commit 35ecf37

13 files changed

+140
-139
lines changed

articles/applied-ai-services/form-recognizer/concept-composed-models.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ With composed models, you can assign multiple custom models to a composed model
3434

3535
* For **_custom template models_**, the composed model can be created using variations of a custom template or different form types. This operation is useful when incoming forms may belong to one of several templates.
3636

37-
* The response will include a ```docType``` property to indicate which of the composed models was used to analyze the document.
37+
* The response includes a ```docType``` property to indicate which of the composed models was used to analyze the document.
3838

3939
* For ```Custom neural``` models the best practice is to add all the different variations of a single document type into a single training dataset and train on custom neural model. Model compose is best suited for scenarios when you have documents of different types being submitted for analysis.
4040

4141
::: moniker-end
4242

4343
::: moniker range="form-recog-3.0.0"
4444

45-
With the introduction of [****custom classifier models****](./concept-custom-classifier.md), you have the option to continue to use [**composed models**](./concept-composed-models.md) or the classifier model as an explicit step before analysis. For a deeper understanding of when to use a classifier or composed model, _see_ [**Custom classifier models**](concept-custom-classifier.md).
45+
With the introduction of [****custom classifier models****](./concept-custom-classifier.md), you can choose to use [**composed models**](./concept-composed-models.md) or the classifier model as an explicit step before analysis. For a deeper understanding of when to use a classifier or composed model, _see_ [**Custom classifier models**](concept-custom-classifier.md).
4646
::: moniker-end
4747

4848
## Compose model limits
@@ -60,9 +60,9 @@ With the introduction of [****custom classifier models****](./concept-custom-cla
6060
|**Custom neural models v3.0 (preview)**|Not Supported|Not Supported|Supported|Not Supported|
6161
|**Custom Neural models v3.0 (GA)**|Not Supported|Not Supported|Not Supported|Supported|
6262

63-
* To compose a model trained with a prior version of the API (v2.1 or earlier), train a model with the v3.0 API using the same labeled dataset. That addition will ensure that the v2.1 model can be composed with other models.
63+
* To compose a model trained with a prior version of the API (v2.1 or earlier), train a model with the v3.0 API using the same labeled dataset. That addition ensures that the v2.1 model can be composed with other models.
6464

65-
* Models composed with v2.1 of the API will continue to be supported, requiring no updates.
65+
* Models composed with v2.1 of the API continues to be supported, requiring no updates.
6666

6767
* The limit for maximum number of custom models that can be composed is 100.
6868

@@ -81,7 +81,7 @@ The following resources are supported by Form Recognizer **v3.0** :
8181

8282
::: moniker range="form-recog-2.1.0"
8383

84-
The following resources are supported by Form Recognizer v2.1:
84+
Form Recognizer v2.1 supports the following resources:
8585

8686
| Feature | Resources |
8787
|----------|-------------------------|

articles/applied-ai-services/form-recognizer/concept-custom-classifier.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ recommendations: false
1818

1919
**This article applies to:** ![Form Recognizer v3.0 checkmark](media/yes-icon.png) **Form Recognizer v3.0**.
2020

21-
Custom classifier models are deep-learning-model types that combines layout and language features to accurately detect and identify documents you process within your application. Custom classifier models can classify each page in a input file to identify the document(s) within and can also identify multiple documents or multiple instances of a single document within an input file.
21+
Custom classifier models are deep-learning-model types that combine layout and language features to accurately detect and identify documents you process within your application. Custom classifier models can classify each page in an input file to identify the document(s) within and can also identify multiple documents or multiple instances of a single document within an input file.
2222

2323
## Model capabilities
2424

@@ -30,7 +30,7 @@ Custom classifier models can analyze a single- or multi-file documents to identi
3030

3131
* A single file containing multiple instances of the same document. For instance, a collection of scanned invoices.
3232

33-
Training a custom classifier model requires at least 2 distinct classes and a minimum of 5 samples per class.
33+
Training a custom classifier model requires at least two distinct classes and a minimum of five samples per class.
3434

3535
### Compare custom classifier and composed models
3636

@@ -39,22 +39,22 @@ A custom classifier model can replace [a composed model](concept-composed-models
3939
| Capability | Custom classifier process | Composed model process |
4040
|--|--|--|
4141
|Analyze a single document of unknown type belonging to one of the types trained for extraction model processing.| &#9679; Requires multiple calls. </br> &#9679; Call the classifier models based on the document class. This step allows for a confidence-based check before invoking the extraction model analysis.</br> &#9679; Invoke the extraction model. | &#9679; Requires a single call to a composed model containing the model corresponding to the input document type. |
42-
|Analyze a single document of unknown type belonging to several types trained for extraction model processing.| &#9679;Requires multiple calls.</br> &#9679; Make a call to the classifier that ignores documents not matching a designated type for extraction.</br> &#9679; Invoke the extraction model. | &#9679; Requires a single call to a composed model. The service will always pick a custom model within the composed model with the highest match.</br> &#9679; A composed model cannot ignore documents.|
43-
|Analyze a file containing multiple documents of known or unknown type belonging to one of the types trained for extraction model processing.| &#9679; Requires multiple calls. </br> &#9679; Call the extraction model for each identified document in the input file.</br> &#9679; Invoke the extraction model. | &#9679; Requires a single call to a composed model.</br> &#9679; The composed model will only invoke the component model once on the first instance of the document. </br> &#9679;The remaining documents are ignored. |
42+
|Analyze a single document of unknown type belonging to several types trained for extraction model processing.| &#9679;Requires multiple calls.</br> &#9679; Make a call to the classifier that ignores documents not matching a designated type for extraction.</br> &#9679; Invoke the extraction model. | &#9679; Requires a single call to a composed model. The service selects a custom model within the composed model with the highest match.</br> &#9679; A composed model can't ignore documents.|
43+
|Analyze a file containing multiple documents of known or unknown type belonging to one of the types trained for extraction model processing.| &#9679; Requires multiple calls. </br> &#9679; Call the extraction model for each identified document in the input file.</br> &#9679; Invoke the extraction model. | &#9679; Requires a single call to a composed model.</br> &#9679; The composed model invokes the component model once on the first instance of the document. </br> &#9679;The remaining documents are ignored. |
4444

4545
## Language support
4646

4747
Classifier models currently only support English language documents.
4848

4949
## Best practices
5050

51-
Custom classifier models require a minimum of five samples per class to train. If the classes are very similar, adding additional training samples will improve model accuracy.
51+
Custom classifier models require a minimum of five samples per class to train. If the classes are similar, adding extra training samples improves model accuracy.
5252

5353
## Training a model
5454

5555
Custom classifier models are only available in the [v3.0 API](v3-migration-guide.md) starting with API version ```2023-02-28-preview```. [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio) provides a no-code user interface to interactively train a custom classifier.
5656

57-
When using the REST API, if your documents are organized by folders, you can use the ```azureBlobSource``` property of the request to train a classifier model.
57+
When using the REST API, if you've organized your documents by folders, you can use the ```azureBlobSource``` property of the request to train a classifier model.
5858

5959
```rest
6060
https://{endpoint}/formrecognizer/documentClassifiers:build?api-version=2023-02-28-preview
@@ -86,7 +86,7 @@ https://{endpoint}/formrecognizer/documentClassifiers:build?api-version=2023-02-
8686
8787
```
8888

89-
Alternatively, if you have a flat list of files or only plan to use a few select files within each folder to train the model, you can use the ```azureBlobFileListSource``` property to train the model. This requires an additional ```file list``` in [JSON Lines](https://jsonlines.org/) format. For each class, add a new file with a list of files to be submitted for training.
89+
Alternatively, if you have a flat list of files or only plan to use a few select files within each folder to train the model, you can use the ```azureBlobFileListSource``` property to train the model. This step requires a ```file list``` in [JSON Lines](https://jsonlines.org/) format. For each class, add a new file with a list of files to be submitted for training.
9090

9191
```rest
9292
{

articles/applied-ai-services/form-recognizer/concept-custom-neural.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ Custom neural models share the same labeling format and strategy as [custom temp
3030

3131
## Model capabilities
3232

33-
Custom neural models currently only support key-value pairs and selection marks and structured fields (tables), future releases will include support for signatures.
33+
Custom neural models currently only support key-value pairs and selection marks and structured fields (tables), future releases include support for signatures.
3434

3535
| Form fields | Selection marks | Tabular fields | Signature | Region |
3636
|:--:|:--:|:--:|:--:|:--:|
3737
| Supported | Supported | Supported | Unsupported | Supported <sup>1</sup> |
3838

39-
<sup>1</sup> Region labels in custom neural models will use the results from the Layout API for specified region. This feature is different from template models where, if no value is present, text is generated at training time.
39+
<sup>1</sup> Region labels in custom neural models use the results from the Layout API for specified region. This feature is different from template models where, if no value is present, text is generated at training time.
4040

4141
### Build mode
4242

@@ -46,11 +46,11 @@ Neural models support documents that have the same information, but different pa
4646

4747
## Language support
4848

49-
Neural models now support additional languages in the ```2023-02-28-preview``` API.
49+
1. Neural models now support added languages in the ```2023-02-28-preview``` API.
5050

5151
| Languages | API version |
5252
|:--:|:--:|
53-
| English | `2022-08-31` (GA) , `2023-02-28-preview`|
53+
| English | `2022-08-31` (GA), `2023-02-28-preview`|
5454
| German | `2023-02-28-preview`|
5555
| Italian | `2023-02-28-preview`|
5656
| French | `2023-02-28-preview`|
@@ -111,7 +111,7 @@ Custom neural models can generalize across different formats of a single documen
111111

112112
### Field naming
113113

114-
When you label the data, labeling the field relevant to the value will improve the accuracy of the key-value pairs extracted. For example, for a field value containing the supplier ID, consider naming the field "supplier_id". Field names should be in the language of the document.
114+
When you label the data, labeling the field relevant to the value improves the accuracy of the key-value pairs extracted. For example, for a field value containing the supplier ID, consider naming the field "supplier_id". Field names should be in the language of the document.
115115

116116
### Labeling contiguous values
117117

@@ -127,7 +127,7 @@ Values in training cases should be diverse and representative. For example, if a
127127
## Current Limitations
128128

129129
* The model doesn't recognize values split across page boundaries.
130-
* Custom neural models are only trained in English and model performance will be lower for documents in other languages.
130+
* Custom neural models are only trained in English. Model performance is lower for documents in other languages.
131131
* If a dataset labeled for custom template models is used to train a custom neural model, the unsupported field types are ignored.
132132
* Custom neural models are limited to 10 build operations per month. Open a support request if you need the limit increased.
133133

articles/applied-ai-services/form-recognizer/concept-custom.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ To create a custom extraction model, label a dataset of documents with the value
3838

3939
### Custom template model
4040

41-
The custom template or custom form model relies on a consistent visual template to extract the labeled data. The accuracy of your model is affected by variances in the visual structure of your documents. Structured forms such as questionnaires or applications are examples of consistent visual templates.
41+
The custom template or custom form model relies on a consistent visual template to extract the labeled data. Variances in the visual structure of your documents affect the accuracy of your model. Structured forms such as questionnaires or applications are examples of consistent visual templates.
4242

43-
Your training set will consist of structured documents where the formatting and layout are static and constant from one document instance to the next. Custom template models support key-value pairs, selection marks, tables, signature fields, and regions. Template models and can be trained on documents in any of the [supported languages](language-support.md). For more information, *see* [custom template models](concept-custom-template.md ).
43+
Your training set consists of structured documents where the formatting and layout are static and constant from one document instance to the next. Custom template models support key-value pairs, selection marks, tables, signature fields, and regions. Template models and can be trained on documents in any of the [supported languages](language-support.md). For more information, *see* [custom template models](concept-custom-template.md ).
4444

4545
> [!TIP]
4646
>
@@ -71,7 +71,7 @@ This table provides links to the build mode programming language SDK references
7171

7272
## Compare model features
7373

74-
The table below compares custom template and custom neural features:
74+
The following table compares custom template and custom neural features:
7575

7676
|Feature|Custom template (form) | Custom neural (document) |
7777
|---|---|---|
@@ -83,11 +83,11 @@ The table below compares custom template and custom neural features:
8383

8484
### Custom classifier model
8585

86-
Document classification is a new scenario supported by Form Recognizer with the ```2023-02-28-preview``` API. Document classifier supports classification and splitting scenarios. Train a classifier model to identify the different types of documents your application supports. The input file for the classifier model can contain multiple documents, the classifier will classify each document within an associated page range. See [custom classification](concept-custom-classifier.md) models to learn more.
86+
Document classification is a new scenario supported by Form Recognizer with the ```2023-02-28-preview``` API. Document classifier supports classification and splitting scenarios. Train a classifier model to identify the different types of documents your application supports. The input file for the classifier model can contain multiple documents and classifies each document within an associated page range. See [custom classification](concept-custom-classifier.md) models to learn more.
8787

8888
## Custom model tools
8989

90-
The following tools are supported by Form Recognizer v3.0:
90+
Form Recognizer v3.0 supports the following tools:
9191

9292
| Feature | Resources | Model ID|
9393
|---|---|:---|
@@ -97,7 +97,7 @@ The following tools are supported by Form Recognizer v3.0:
9797

9898
::: moniker range="form-recog-2.1.0"
9999

100-
The following tools are supported by Form Recognizer v2.1:
100+
Form Recognizer v2.1 supports the following tools:
101101

102102
> [!NOTE]
103103
> Custom model types [custom neural](concept-custom-neural.md) and [custom template](concept-custom-template.md) are only available with Form Recognizer version v3.0.
@@ -205,7 +205,7 @@ This table compares the supported data extraction areas:
205205
**Table symbols**:
206206
✔—supported;
207207
**n/a—currently unavailable;
208-
*-behaves differently. With template models, synthetic data is generated at training time. With neural models, exiting text recognized in he region is selected.
208+
*-behaves differently. With template models, synthetic data is generated at training time. With neural models, exiting text recognized in the region is selected.
209209

210210
> [!TIP]
211211
> When choosing between the two model types, start with a custom neural model if it meets your functional needs. See [custom neural](concept-custom-neural.md ) to learn more about custom neural models.

0 commit comments

Comments
 (0)