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
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/compose-custom-models-preview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ To get started, you'll need the following resources:
38
38
:::image border="true" type="content" source="media/containers/keys-and-endpoint.png" alt-text="Still photo showing how to access resource key and endpoint URL.":::
39
39
40
40
> [!TIP]
41
-
> For more information, see*[**create a Form Recognizer resource**](create-a-form-recognizer-resource.md).
41
+
> For more information, see [**create a Form Recognizer resource**](create-a-form-recognizer-resource.md).
42
42
43
43
***An Azure storage account.** If you don't know how to create an Azure storage account, follow the [Azure Storage quickstart for Azure portal](../../storage/blobs/storage-quickstart-blobs-portal.md). You can use the free pricing tier (F0) to try the service, and upgrade later to a paid tier for production.
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/concept-custom-neural.md
+16-28Lines changed: 16 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ manager: nitinme
7
7
ms.service: applied-ai-services
8
8
ms.subservice: forms-recognizer
9
9
ms.topic: conceptual
10
-
ms.date: 06/06/2022
10
+
ms.date: 07/11/2022
11
11
ms.author: lajanuar
12
12
ms.custom: references_regions
13
13
recommendations: false
@@ -37,8 +37,8 @@ Custom neural models currently only support key-value pairs and selection marks,
37
37
38
38
With the release of API version **2022-06-30-preview**, custom neural models will support tabular fields (tables):
39
39
40
-
* Models trained with API version 2022-06-30-preview or later will accept tabular field labels.
41
-
* Documents analyzed with custom neural models using API version 2022-06-30-preview or later will produce tabular fields aggregated across the tables.
40
+
* Models trained with API version 2022-06-30-preview or later will accept tabular field labels.
41
+
* Documents analyzed with custom neural models using API version 2022-06-30-preview or later will produce tabular fields aggregated across the tables.
42
42
* The results can be found in the ```analyzeResult``` object's ```documents``` array that is returned following an analysis operation.
43
43
44
44
Tabular fields support **cross page tables** by default:
@@ -50,34 +50,22 @@ Tabular fields are also useful when extracting repeating information within a do
50
50
51
51
## Supported regions
52
52
53
-
For the **2022-06-30-preview**, custom neural models can only be trained in the following Azure regions:
54
-
55
-
* AustraliaEast
56
-
* BrazilSouth
57
-
* CanadaCentral
58
-
* CentralIndia
59
-
* CentralUS
60
-
* EastUS
61
-
* EastUS2
62
-
* FranceCentral
63
-
* JapanEast
64
-
* JioIndiaWest
65
-
* KoreaCentral
66
-
* NorthEurope
67
-
* SouthCentralUS
68
-
* SoutheastAsia
69
-
* UKSouth
70
-
* WestEurope
71
-
* WestUS
72
-
* WestUS2
73
-
* WestUS3
53
+
As of August 01 2022, Form Recognizer custom neural model training will only be available in the following Azure regions until further notice:
54
+
55
+
* Brazil South
56
+
* Canada Central
57
+
* Central India
58
+
* Japan East
59
+
* North Europe
60
+
* South Central US
61
+
* Southeast Asia
74
62
75
63
> [!TIP]
76
-
> You can copy a model trained in one of the select regions listed above to **any other region** and use it accordingly.
64
+
> You can [copy a model](disaster-recovery.md) trained in one of the select regions listed above to **any other region** and use it accordingly.
77
65
78
66
## Best practices
79
67
80
-
Custom neural models differ from custom template models in a few different ways. The custom template or model relies on a consistent visual template to extract the labeled data. Custom neural models support structured, semi-structured, and unstructured documents to extract fields. When you're choosing between the two model types, start with a neural model and test to determine if it supports your functional needs.
68
+
Custom neural models differ from custom template models in a few different ways. The custom template or model relies on a consistent visual template to extract the labeled data. Custom neural models support structured, semi-structured, and unstructured documents to extract fields. When you're choosing between the two model types, start with a neural model, and test to determine if it supports your functional needs.
81
69
82
70
### Dealing with variations
83
71
@@ -98,7 +86,6 @@ Value tokens/words of one field must be either
98
86
99
87
Values in training cases should be diverse and representative. For example, if a field is named "date", values for this field should be a date. synthetic value like a random string can affect model performance.
100
88
101
-
102
89
## Current Limitations
103
90
104
91
* The model doesn't recognize values split across page boundaries.
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/deploy-label-tool.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ ms.author: lajanuar
17
17
>
18
18
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio (preview)](https://formrecognizer.appliedai.azure.com/studio).
19
19
> * The v3.0 Studio supports any model trained with v2.1 labeled data.
20
-
> * You can refer to the API migration guide for detailed information about migrating from v2.1 to v3.0.
20
+
> * You can refer to the [API migration guide](v3-migration-guide.md) for detailed information about migrating from v2.1 to v3.0.
21
21
> **See* our [**REST API**](quickstarts/try-v3-rest-api.md) or [**C#**](quickstarts/try-v3-csharp-sdk.md), [**Java**](quickstarts/try-v3-java-sdk.md), [**JavaScript**](quickstarts/try-v3-javascript-sdk.md), or [Python](quickstarts/try-v3-python-sdk.md) SDK quickstarts to get started with the V3.0 preview.
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/how-to-guides/build-custom-model-v3.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ The Form Recognizer Studio provides and orchestrates all the API calls required
49
49
1. On the next step in the workflow, choose or create a Form Recognizer resource before you select continue.
50
50
51
51
> [!IMPORTANT]
52
-
> Custom neural models models are only available in a few regions. If you plan on training a neural model, please select or create a resource in one of [these supported regions](../concept-custom-neural.md).
52
+
> Custom neural models models are only available in a few regions. If you plan on training a neural model, please select or create a resource in one of [these supported regions](../concept-custom-neural.md#supported-regions).
53
53
54
54
:::image type="content" source="../media/how-to/studio-select-resource.png" alt-text="Screenshot: Select the Form Recognizer resource.":::
* The [Visual Studio IDE](https://visualstudio.microsoft.com/vs/) or current version of [.NET Core](https://dotnet.microsoft.com/download/dotnet-core).
29
29
* An Azure Storage blob that contains a set of training data. See [Build a training data set for a custom model](../../build-training-data-set.md) for tips and options for putting together your training data set. For this project, you can use the files under the **Train** folder of the [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) (download and extract *sample_data.zip*).
30
30
* Once you have your Azure subscription, <ahref="https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer"title="Create a Form Recognizer resource"target="_blank">create a Form Recognizer resource </a> in the Azure portal to get your key and endpoint. After it deploys, select **Go to resource**.
31
-
* You will need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. Paste your key and endpoint into the code below later in the project.
31
+
* You'll need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. Paste your key and endpoint into the code below later in the project.
32
32
* You can use the free pricing tier (`F0`) to try the service, and upgrade later to a paid tier for production.
33
+
> [!TIP]
34
+
> Create a Cognitive Services resource if you plan to access multiple cognitive services under a single endpoint/key. For Form Recognizer access only, create a Form Recognizer resource. Please note that you'll need a single-service resource if you intend to use [Azure Active Directory authentication](../../../../active-directory/authentication/overview-authentication.md).
33
35
34
36
## Setting up
35
37
@@ -76,7 +78,7 @@ In the application's **Program** class, create variables for your resource's key
@@ -86,11 +88,11 @@ With Form Recognizer, you can create two different client types. The first, `For
86
88
87
89
### FormRecognizerClient
88
90
89
-
`FormRecognizerClient` provides operations for:
91
+
`FormRecognizerClient` provides the following operations:
90
92
91
-
*Recognizing form fields and content, using custom models trained to analyze your custom forms. These values are returned in a collection of `RecognizedForm` objects. See example [Analyze custom forms](#analyze-forms-with-a-custom-model).
92
-
*Recognizing form content, including tables, lines and words, without the need to train a model. Form content is returned in a collection of `FormPage` objects. See example [Analyze layout](#analyze-layout).
93
-
*Recognizing common fields from US receipts, business cards, invoices, and ID documents using a pre-trained model on the Form Recognizer service.
93
+
*Recognize form fields and content, using custom models trained to analyze your custom forms. These values are returned in a collection of `RecognizedForm` objects. See example [Analyze custom forms](#analyze-forms-with-a-custom-model).
94
+
*Recognize form content, including tables, lines and words, without the need to train a model. Form content is returned in a collection of `FormPage` objects. See example [Analyze layout](#analyze-layout).
95
+
*Recognize common fields from US receipts, business cards, invoices, and ID documents using a pre-trained model on the Form Recognizer service.
94
96
95
97
### FormTrainingClient
96
98
@@ -289,7 +291,7 @@ The following code processes the ID document at the given URI and prints the maj
289
291
290
292
## Train a custom model
291
293
292
-
This section demonstrates how to train a model with your own data. A trained model can output structured data that includes the key/value relationships in the original form document. After you train the model, you can test and retrain it and eventually use it to reliably extract data from more forms according to your needs.
294
+
This section demonstrates how to train a model with your own data. A trained model can output structured data that includes the key/value relationships in the original form document. After you train the model, you can test, retrain, and eventually use it to reliably extract data from more forms according to your needs.
293
295
294
296
> [!NOTE]
295
297
> You can also train models with a graphical user interface such as the [Form Recognizer Sample Labeling tool](../../label-tool.md).
@@ -366,7 +368,7 @@ Submodel Form Type: form-0
366
368
367
369
### Train a model with labels
368
370
369
-
You can also train custom models by manually labeling the training documents. Training with labels leads to better performance in some scenarios. To train with labels, you need to have special label information files (`\<filename\>.pdf.labels.json`) in your blob storage container alongside the training documents. The [Form Recognizer Sample Labeling tool](../../label-tool.md) provides a UI to help you create these label files. Once you have them, you can call the `StartTrainingAsync` method with the `uselabels` parameter set to `true`.
371
+
You can also train custom models by manually labeling the training documents. Training with labels leads to better performance in some scenarios. To train with labels, you need to have special label information files (`\<filename\>.pdf.labels.json`) in your blob storage container alongside the training documents. The [Form Recognizer Sample Labeling tool](../../label-tool.md) provides a UI to help you create these label files. Once you've them, you can call the `StartTrainingAsync` method with the `uselabels` parameter set to `true`.
0 commit comments