You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[!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
19
24
20
25
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.
21
26
27
+
::: moniker range="form-recog-3.0.0"
28
+
22
29
Custom template models share the same labeling format and strategy as custom neural models, with support for more field types and languages.
23
30
31
+
::: moniker-end
32
+
24
33
## Model capabilities
25
34
26
35
Custom template models support key-value pairs, selection marks, tables, signature fields, and selected regions.
The build custom model operation has added support for the *template* and *neural* custom models. Previous versions of the REST API and SDKs only supported a single build mode that is now known as the *template* mode.
35
-
36
-
Template models only accept documents that have the same basic page structure—a uniform visual appearance—or the same relative positioning of elements within the document. For more information, *see*[Custom model build mode](concept-custom.md#build-mode)
41
+
::: moniker range="form-recog-3.0.0"
37
42
38
43
## Tabular fields
39
44
@@ -44,20 +49,23 @@ With the release of API versions **2022-06-30-preview** and later, custom templ
44
49
45
50
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.
46
51
52
+
::: moniker-end
53
+
47
54
## Dealing with variations
48
55
49
56
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.
50
57
51
58
## Training a model
52
59
53
-
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 with Form Recognizer Studio to train a custom template model.
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```.
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).
[!INCLUDE [applies to v3.0](includes/applies-to-v3-0.md)]
21
+
::: moniker-end
21
22
22
-
* 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.
23
+
::: moniker range="form-recog-2.1.0"
24
+
[!INCLUDE [applies to v2.1](includes/applies-to-v2-1.md)]
25
+
::: moniker-end
23
26
24
-
* For the usage with [Form Recognizer SDK](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [Form Recognizer REST API](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [Form Recognizer Studio](quickstarts/try-v3-form-recognizer-studio.md) and [Sample Labeling Tool](https://fott-2-1.azurewebsites.net/):
27
+
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.
| Quota | Free (F0) <sup>1</sup> | Standard (S0) |
67
104
|--|--|--|
68
105
|**Compose Model limit**| 5 | 100 (default value) |
69
106
| Adjustable | No | No |
@@ -74,19 +111,28 @@ recommendations: false
74
111
75
112
::: moniker-end
76
113
77
-
<sup>1</sup> For **Free (F0)** pricing tier see also monthly allowances at the [pricing page](https://azure.microsoft.com/pricing/details/form-recognizer/).</br>
78
-
<sup>2</sup> See [best practices](#example-of-a-workload-pattern-best-practice), and [adjustment instructions](#create-and-submit-support-request).
114
+
::: moniker range=">=form-recog-2.1.0"
115
+
116
+
> <sup>1</sup> For **Free (F0)** pricing tier see also monthly allowances at the [pricing page](https://azure.microsoft.com/pricing/details/form-recognizer/).</br>
117
+
> <sup>2</sup> See [best practices](#example-of-a-workload-pattern-best-practice), and [adjustment instructions(#create-and-submit-support-request).</br>
118
+
> <sup>3</sup> Open a support request to increase the monthly training limit.
119
+
::: moniker-end
120
+
::: moniker range="form-recog-3.0.0"
121
+
> <sup>4</sup> This limit applies to all documents found in your training dataset folder prior to any labeling-related updates.
122
+
::: moniker-end
79
123
80
124
## Detailed description, Quota adjustment, and best practices
81
125
82
-
Before requesting a quota increase (where applicable), ensure that it's necessary. Form Recognizer service uses autoscaling to bring the required computational resources in "on-demand" and at the same time to keep the customer costs low, deprovision unused resources by not maintaining an excessive amount of hardware capacity. If your application receives a Response Code 429 ("Too many requests") while your workload is within the defined limits, the most likely explanation is that the service is scaling up to your demand, but hasn't yet reached the required scale. Thus the service doesn't immediately have enough resources to serve the request. This state is transient and shouldn't last long. For more information, *see*[Quotas and Limits quick reference](#form-recognizer-service-quotas-and-limits))
126
+
Before requesting a quota increase (where applicable), ensure that it's necessary. Form Recognizer service uses autoscaling to bring the required computational resources in "on-demand" and at the same time to keep the customer costs low, deprovision unused resources by not maintaining an excessive amount of hardware capacity.
127
+
128
+
If your application returns Response Code 429 (*Too many requests*) and your workload is within the defined limits: most likely, the service is scaling up to your demand, but hasn't yet reached the required scale. Thus the service doesn't immediately have enough resources to serve the request. This state is transient and shouldn't last long. For more information, *see*[Quotas and Limits quick reference](#form-recognizer-service-quotas-and-limits))
83
129
84
130
### General best practices to mitigate throttling during autoscaling
85
131
86
132
To minimize issues related to throttling (Response Code 429), we recommend using the following techniques:
87
133
88
-
- Implement retry logic in your application
89
-
- Avoid sharp changes in the workload. Increase the workload gradually <br/>
134
+
* Implement retry logic in your application
135
+
* Avoid sharp changes in the workload. Increase the workload gradually <br/>
90
136
*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.
91
137
92
138
The next sections describe specific cases of adjusting quotas.
@@ -100,7 +146,7 @@ Increasing the Concurrent Request limit does **not** directly affect your costs.
100
146
101
147
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.
102
148
103
-
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.
149
+
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.
104
150
105
151
#### Have the required information ready
106
152
@@ -119,21 +165,21 @@ If you would like to increase your transactions per second, you can enable auto
119
165
120
166
Initiate the increase of transactions per second(TPS) limit for your resource by submitting the Support Request:
121
167
122
-
- Ensure you have the [required information](#have-the-required-information-ready)
123
-
- Go to [Azure portal](https://portal.azure.com/)
124
-
- Select the Form Recognizer Resource for which you would like to increase the TPS limit
125
-
- Select *New support request* (*Support + troubleshooting* group)
126
-
- A new window will appear with auto-populated information about your Azure Subscription and Azure Resource
127
-
- Enter *Summary* (like "Increase Form Recognizer TPS limit")
128
-
- In Problem type,* select "Quota or usage validation"
129
-
- Select *Next: Solutions*
130
-
- Proceed further with the request creation
131
-
- Under the *Details* tab enters the following in the *Description* field:
132
-
- a note, that the request is about **Form Recognizer** quota.
133
-
- Provide a TPS expectation you would like to scale to meet.
134
-
- Azure resource information you [collected](#have-the-required-information-ready).
135
-
- Complete entering the required information and select *Create* button in *Review + create* tab
136
-
- Note the support request number in Azure portal notifications. You'll be contacted shortly for further processing
168
+
* Ensure you have the [required information](#have-the-required-information-ready)
169
+
* Go to [Azure portal](https://portal.azure.com/)
170
+
* Select the Form Recognizer Resource for which you would like to increase the TPS limit
171
+
* Select *New support request* (*Support + troubleshooting* group)
172
+
* A new window will appear with auto-populated information about your Azure Subscription and Azure Resource
173
+
* Enter *Summary* (like "Increase Form Recognizer TPS limit")
174
+
* In Problem type,* select "Quota or usage validation"
175
+
* Select *Next: Solutions*
176
+
* Proceed further with the request creation
177
+
* Under the *Details* tab enters the following in the *Description* field:
178
+
* a note, that the request is about **Form Recognizer** quota.
179
+
* Provide a TPS expectation you would like to scale to meet.
180
+
* Azure resource information you [collected](#have-the-required-information-ready).
181
+
* Complete entering the required information and select *Create* button in *Review + create* tab
182
+
* Note the support request number in Azure portal notifications. You'll be contacted shortly for further processing
0 commit comments