Skip to content

Commit 4bccc48

Browse files
committed
edit for pub
1 parent e5517b9 commit 4bccc48

File tree

2 files changed

+79
-30
lines changed

2 files changed

+79
-30
lines changed

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

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,27 @@ ms.subservice: forms-recognizer
99
ms.topic: conceptual
1010
ms.date: 10/10/2022
1111
ms.author: lajanuar
12-
monikerRange: 'form-recog-3.0.0'
1312
recommendations: false
1413
---
1514

1615
# Custom template document model
1716

18-
**This article applies to:** ![Form Recognizer v3.0 checkmark](media/yes-icon.png) **Form Recognizer v3.0**.
17+
::: moniker range="form-recog-3.0.0"
18+
[!INCLUDE [applies to v3.0](includes/applies-to-v3-0.md)]
19+
::: moniker-end
20+
21+
::: moniker range="form-recog-2.1.0"
22+
[!INCLUDE [applies to v2.1](includes/applies-to-v2-1.md)]
23+
::: moniker-end
1924

2025
Custom template (formerly custom form) is an easy-to-train document model that accurately extracts labeled key-value pairs, selection marks, tables, regions, and signatures from documents. Template models use layout cues to extract values from documents and are suitable to extract fields from highly structured documents with defined visual templates.
2126

27+
::: moniker range="form-recog-3.0.0"
28+
2229
Custom template models share the same labeling format and strategy as custom neural models, with support for more field types and languages.
2330

31+
::: moniker-end
32+
2433
## Model capabilities
2534

2635
Custom template models support key-value pairs, selection marks, tables, signature fields, and selected regions.
@@ -29,6 +38,8 @@ Custom template models support key-value pairs, selection marks, tables, signatu
2938
|:--:|:--:|:--:|:--:|:--:|
3039
| Supported| Supported | Supported | Supported| Supported |
3140

41+
::: moniker range="form-recog-3.0.0"
42+
3243
## Tabular fields
3344

3445
With the release of API versions **2022-06-30-preview** and later, custom template models will add support for **cross page** tabular fields (tables):
@@ -38,20 +49,23 @@ With the release of API versions **2022-06-30-preview** and later, custom templ
3849

3950
Tabular fields are also useful when extracting repeating information within a document that isn't recognized as a table. For example, a repeating section of work experiences in a resume can be labeled and extracted as a tabular field.
4051

52+
::: moniker-end
53+
4154
## Dealing with variations
4255

4356
Template models rely on a defined visual template, changes to the template will result in lower accuracy. In those instances, split your training dataset to include at least five samples of each template and train a model for each of the variations. You can then [compose](concept-composed-models.md) the models into a single endpoint. For subtle variations, like digital PDF documents and images, it's best to include at least five examples of each type in the same training dataset.
4457

4558
## Training a model
4659

47-
Template models are available generally [v3.0 API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/BuildDocumentModel) and [v2.1 API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeWithCustomForm). If you're starting with a new project or have an existing labeled dataset, work with the v3 API and Form Recognizer Studio to train a custom template model.
60+
::: moniker range="form-recog-3.0.0"
61+
62+
Custom template models are generally available with the [v3.0 API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/BuildDocumentModel). If you're starting with a new project or have an existing labeled dataset, use the v3 API and Form Recognizer Studio to train a custom template model.
4863

4964
| Model | REST API | SDK | Label and Test Models|
5065
|--|--|--|--|
5166
| Custom template | [Form Recognizer 3.0 ](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)| [Form Recognizer SDK](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true)| [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio)|
52-
| Custom template | [Form Recognizer 2.1 ](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeWithCustomForm)| [Form Recognizer SDK](quickstarts/get-started-v2-1-sdk-rest-api.md?pivots=programming-language-python)| [Form Recognizer Sample labeling tool](https://fott-2-1.azurewebsites.net/)|
5367

54-
On the v3 API, the build operation to train model supports a new ```buildMode``` property, to train a custom template model, set the ```buildMode``` to ```template```.
68+
With the v3.0 API, the build operation to train model supports a new ```buildMode``` property, to train a custom template model, set the ```buildMode``` to ```template```.
5569

5670
```REST
5771
https://{endpoint}/formrecognizer/documentModels:build?api-version=2022-08-31
@@ -68,10 +82,34 @@ https://{endpoint}/formrecognizer/documentModels:build?api-version=2022-08-31
6882
}
6983
```
7084

85+
::: moniker-end
86+
87+
::: moniker range="form-recog-2.1.0"
88+
89+
Custom (template) models are generally available with the [v2.1 API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeWithCustomForm).
90+
91+
| Model | REST API | SDK | Label and Test Models|
92+
|--|--|--|--|
93+
| Custom model (template) | [Form Recognizer 2.1 ](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeWithCustomForm)| [Form Recognizer SDK](quickstarts/get-started-v2-1-sdk-rest-api.md?pivots=programming-language-python)| [Form Recognizer Sample labeling tool](https://fott-2-1.azurewebsites.net/)|
94+
95+
::: moniker-end
96+
7197
## Next steps
7298

7399
Learn to create and compose custom models:
74100

101+
::: moniker range="form-recog-3.0.0"
102+
75103
> [!div class="nextstepaction"]
76104
> [**Build a custom model**](how-to-guides/build-a-custom-model.md)
77105
> [**Compose custom models**](how-to-guides/compose-custom-models.md)
106+
107+
::: moniker-end
108+
109+
::: moniker range="form-recog-2.1.0"
110+
111+
> [!div class="nextstepaction"]
112+
> [**Build a custom model**](concept-custom.md?view=form-recog-2.1.0#build-a-custom-model)
113+
> [**Compose custom models**](concept-composed-models.md?view=form-recog-2.1.0#development-options)
114+
115+
::: moniker-end

articles/applied-ai-services/form-recognizer/service-limits.md

Lines changed: 36 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ recommendations: false
2525
[!INCLUDE [applies to v2.1](includes/applies-to-v2-1.md)]
2626
::: moniker-end
2727

28-
* This article contains a quick reference and the **detailed description** of Azure Form Recognizer service Quotas and Limits for all [pricing tiers](https://azure.microsoft.com/pricing/details/form-recognizer/). It also contains some best practices to avoid request throttling.
28+
This article contains both a quick reference and detailed description of Azure Form Recognizer service Quotas and Limits for all [pricing tiers](https://azure.microsoft.com/pricing/details/form-recognizer/). It also contains some best practices to avoid request throttling.
2929

30-
## Model usuage
30+
## Model usage
3131

3232
> [!div class="checklist"]
3333
>
@@ -55,19 +55,25 @@ recommendations: false
5555

5656
::: moniker range="form-recog-3.0.0"
5757

58-
## Custom model usuage
58+
## Custom model usage
59+
60+
> [!div class="checklist"]
61+
>
62+
> * [**Custom template model**](concept-custom-template.md)
63+
> * [**Custom neural model**](concept-custom-neural.md)
64+
> * [**Composed custom models**](concept-composed-models.md)
5965
6066
|Quota|Free (F0) <sup>1</sup>|Standard (S0)|
6167
|--|--|--|
6268
| **Compose Model limit** | 5 | 200 (default value) |
6369
| Adjustable | No | No |
64-
| **Training dataset size - Neural** | 1 GB <sup>3</sup> | 1 GB (default value) |
70+
| **Training dataset size * Neural** | 1 GB <sup>3</sup> | 1 GB (default value) |
6571
| Adjustable | No | No |
66-
| **Training dataset size - Template** | 50 MB <sup>4</sup> | 50 MB (default value) |
72+
| **Training dataset size * Template** | 50 MB <sup>4</sup> | 50 MB (default value) |
6773
| Adjustable | No | No |
68-
| **Max number of pages (Training) - Template** | 500 | 500 (default value) |
74+
| **Max number of pages (Training) * Template** | 500 | 500 (default value) |
6975
| Adjustable | No | No |
70-
| **Max number of pages (Training) - Neural** | 50,000 | 50,000 (default value) |
76+
| **Max number of pages (Training) * Neural** | 50,000 | 50,000 (default value) |
7177
| Adjustable | No | No |
7278
| **Custom neural model train** | 10 per month | 10 per month |
7379
| Adjustable | No |Yes <sup>3</sup>|
@@ -78,6 +84,11 @@ recommendations: false
7884

7985
## Custom model limits v2.1
8086

87+
> [!div class="checklist"]
88+
>
89+
> * [**Custom template model**](concept-custom-template.md)
90+
> * [**Composed custom models**](concept-composed-models.md)
91+
8192
| Quota | Free (F0) <sup>1</sup> | Standard (S0) |
8293
|--|--|--|
8394
| **Compose Model limit** | 5 | 100 (default value) |
@@ -109,8 +120,8 @@ If your application returns Response Code 429 (*Too many requests*) and your wor
109120

110121
To minimize issues related to throttling (Response Code 429), we recommend using the following techniques:
111122

112-
- Implement retry logic in your application
113-
- Avoid sharp changes in the workload. Increase the workload gradually <br/>
123+
* Implement retry logic in your application
124+
* Avoid sharp changes in the workload. Increase the workload gradually <br/>
114125
*Example.* Your application is using Form Recognizer and your current workload is 10 TPS (transactions per second). The next second you increase the load to 40 TPS (that is four times more). The Service immediately starts scaling up to fulfill the new load, but likely it will not be able to do it within a second, so some of the requests will get Response Code 429.
115126

116127
The next sections describe specific cases of adjusting quotas.
@@ -124,7 +135,7 @@ Increasing the Concurrent Request limit does **not** directly affect your costs.
124135

125136
Existing value of Concurrent Request limit parameter is **not** visible via Azure portal, Command-Line tools, or API requests. To verify the existing value, create an Azure Support Request.
126137

127-
If you would like to increase your transactions per second, you can enable auto scaling on your resource. Follow this document to enable auto scaling on your resource - [enable auto scaling](../../cognitive-services/autoscale.md). You can also submit an increase TPS support request.
138+
If you would like to increase your transactions per second, you can enable auto scaling on your resource. Follow this document to enable auto scaling on your resource * [enable auto scaling](../../cognitive-services/autoscale.md). You can also submit an increase TPS support request.
128139

129140
#### Have the required information ready
130141

@@ -143,21 +154,21 @@ If you would like to increase your transactions per second, you can enable auto
143154

144155
Initiate the increase of transactions per second(TPS) limit for your resource by submitting the Support Request:
145156

146-
- Ensure you have the [required information](#have-the-required-information-ready)
147-
- Go to [Azure portal](https://portal.azure.com/)
148-
- Select the Form Recognizer Resource for which you would like to increase the TPS limit
149-
- Select *New support request* (*Support + troubleshooting* group)
150-
- A new window will appear with auto-populated information about your Azure Subscription and Azure Resource
151-
- Enter *Summary* (like "Increase Form Recognizer TPS limit")
152-
- In Problem type,* select "Quota or usage validation"
153-
- Select *Next: Solutions*
154-
- Proceed further with the request creation
155-
- Under the *Details* tab enters the following in the *Description* field:
156-
- a note, that the request is about **Form Recognizer** quota.
157-
- Provide a TPS expectation you would like to scale to meet.
158-
- Azure resource information you [collected](#have-the-required-information-ready).
159-
- Complete entering the required information and select *Create* button in *Review + create* tab
160-
- Note the support request number in Azure portal notifications. You'll be contacted shortly for further processing
157+
* Ensure you have the [required information](#have-the-required-information-ready)
158+
* Go to [Azure portal](https://portal.azure.com/)
159+
* Select the Form Recognizer Resource for which you would like to increase the TPS limit
160+
* Select *New support request* (*Support + troubleshooting* group)
161+
* A new window will appear with auto-populated information about your Azure Subscription and Azure Resource
162+
* Enter *Summary* (like "Increase Form Recognizer TPS limit")
163+
* In Problem type,* select "Quota or usage validation"
164+
* Select *Next: Solutions*
165+
* Proceed further with the request creation
166+
* Under the *Details* tab enters the following in the *Description* field:
167+
* a note, that the request is about **Form Recognizer** quota.
168+
* Provide a TPS expectation you would like to scale to meet.
169+
* Azure resource information you [collected](#have-the-required-information-ready).
170+
* Complete entering the required information and select *Create* button in *Review + create* tab
171+
* Note the support request number in Azure portal notifications. You'll be contacted shortly for further processing
161172

162173
## Example of a workload pattern best practice
163174

0 commit comments

Comments
 (0)