Skip to content

Commit 5f081e8

Browse files
Merge pull request #111159 from PatrickFarley/formre-updates
[cog serv] Formre updates
2 parents e6884ba + 7a4e946 commit 5f081e8

File tree

6 files changed

+246
-232
lines changed

6 files changed

+246
-232
lines changed

articles/cognitive-services/form-recognizer/deploy-label-tool.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: nitinme
77
ms.service: cognitive-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 03/20/2020
10+
ms.date: 04/14/2020
1111
ms.author: pafarley
1212
---
1313

@@ -71,6 +71,7 @@ Follow these steps to create a new resource using the Azure portal:
7171
* Username (Optional) - Create a username.
7272
* Password (Optional) - Create a secure password that you'll remember.
7373
* Image and tag - Set this to `mcr.microsoft.com/azure-cognitive-services/custom-form/labeltool:latest`
74+
* Continuous Deployment - Set this to **On** if you want to receive automatic updates when the development team makes changes to the sample labeling tool.
7475
* Startup command - Set this to `./run.sh eula=accept`
7576

7677
> [!div class="mx-imgBorder"]
-7.43 KB
Loading

articles/cognitive-services/form-recognizer/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Explore the [REST API reference documentation](https://westus2.dev.cognitive.mic
8989

9090
The input requirements for the receipt model are slightly different.
9191

92-
* Format must be JPEG, PNG, BMP, PDF (text or scanned) or TIFF.
92+
* Format must be JPEG, PNG, PDF (text or scanned) or TIFF.
9393
* File size must be less than 20 MB.
9494
* Image dimensions must be between 50 x 50 pixels and 10000 x 10000 pixels.
9595
* PDF dimensions must be at most 17 x 17 inches, corresponding to Legal or A3 paper sizes and smaller.

articles/cognitive-services/form-recognizer/quickstarts/label-tool.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: forms-recognizer
1010
ms.topic: quickstart
11-
ms.date: 02/19/2020
11+
ms.date: 04/14/2020
1212
ms.author: pafarley
1313
---
1414

@@ -100,7 +100,7 @@ Fill in the fields with the following values:
100100
In the sample labeling tool, projects store your configurations and settings. Create a new project and fill in the fields with the following values:
101101
102102
* **Display Name** - the project display name
103-
* **Security Token** - Some project settings can include sensitive values, such as API keys or other shared secrets. Each project will generate a security token that can be used to encrypt/decrypt sensitive project settings. You can find security tokens in the Application Settings by clicking the gear icon in the lower corner of the left navigation bar.
103+
* **Security Token** - Some project settings can include sensitive values, such as API keys or other shared secrets. Each project will generate a security token that can be used to encrypt/decrypt sensitive project settings. You can find security tokens in the Application Settings by clicking the gear icon at the bottom of the left navigation bar.
104104
* **Source Connection** - The Azure Blob Storage connection you created in the previous step that you would like to use for this project.
105105
* **Folder Path** - Optional - If your source forms are located in a folder on the blob container, specify the folder name here
106106
* **Form Recognizer Service Uri** - Your Form Recognizer endpoint URL.
@@ -126,9 +126,9 @@ Click **Run OCR on all files** on the left pane to get the text layout informati
126126
Next, you'll create tags (labels) and apply them to the text elements that you want the model to recognize.
127127
128128
1. First, use the tags editor pane to create the tags you'd like to identify.
129-
1. Click **+** to create a new tag.
130-
1. Enter the tag name.
131-
1. Press Enter to save the tag.
129+
1. Click **+** to create a new tag.
130+
1. Enter the tag name.
131+
1. Press Enter to save the tag.
132132
1. In the main editor, click and drag to select one or multiple words from the highlighted text elements.
133133
1. Click on the tag you want to apply, or press the corresponding keyboard key. The number keys are assigned as hotkeys for the first 10 tags. You can reorder your tags using the up and down arrow icons in the tag editor pane.
134134
> [!Tip]
@@ -140,15 +140,30 @@ Next, you'll create tags (labels) and apply them to the text elements that you w
140140
> * Don't include keys in your tagged fields—only the values.
141141
> * Table data should be detected automatically and will be available in the final output JSON file. However, if the model fails to detect all of your table data, you can manually tag these fields as well. Tag each cell in the table with a different label. If your forms have tables with varying numbers of rows, make sure you tag at least one form with the largest possible table.
142142
143+
![Main editor window of sample labeling tool](../media/label-tool/main-editor.png)
143144
144-
Follow the above steps to label five of your forms, and then move on to the next step.
145+
Follow the steps above to label at least five of your forms.
145146
146-
![Main editor window of sample labeling tool](../media/label-tool/main-editor.png)
147+
### Specify tag value types
147148
149+
Optionally, you can set the expected data type for each tag. Open the context menu to the right of a tag and select a type from the menu. This feature allows the detection algorithm to make certain assumptions that will improve the text-detection accuracy. It also ensures that the detected values will be returned in a standardized format in the final JSON output.
150+
151+
> [!div class="mx-imgBorder"]
152+
> ![Value type selection with sample labeling tool](../media/whats-new/formre-value-type.png)
153+
154+
The following value types and variations are currently supported:
155+
* `string`
156+
* default, `no-whitespaces`, `alphanumeric`
157+
* `number`
158+
* default, `currency`
159+
* `date`
160+
* default, `dmy`, `mdy`, `ymd`
161+
* `time`
162+
* `integer`
148163
149164
## Train a custom model
150165
151-
Click the Train icon (the train car) on the left pane to open the Training page. Then click the **Train** button to begin training the model. Once the training process completes, you'll see the following information:
166+
Click the Train icon on the left pane to open the Training page. Then click the **Train** button to begin training the model. Once the training process completes, you'll see the following information:
152167
153168
* **Model ID** - The ID of the model that was created and trained. Each training call creates a new model with its own ID. Copy this string to a secure location; you'll need it if you want to do prediction calls through the REST API.
154169
* **Average Accuracy** - The model's average accuracy. You can improve model accuracy by labeling additional forms and training again to create a new model. We recommend starting by labeling five forms and adding more forms as needed.
@@ -163,7 +178,7 @@ After training finishes, examine the **Average Accuracy** value. If it's low, yo
163178
164179
## Analyze a form
165180
166-
Click on the Predict (rectangles) icon on the left to test your model. Upload a form document that you haven't used in the training process. Then click the **Predict** button on the right to get key/value predictions for the form. The tool will apply tags in bounding boxes and will report the confidence of each tag.
181+
Click on the Predict (light bulb) icon on the left to test your model. Upload a form document that you haven't used in the training process. Then click the **Predict** button on the right to get key/value predictions for the form. The tool will apply tags in bounding boxes and will report the confidence of each tag.
167182
168183
> [!TIP]
169184
> You can also run the Analyze API with a REST call. To learn how to do this, see [Train with labels using Python](./python-labeled-data.md).

0 commit comments

Comments
 (0)