Skip to content

Commit 3172f28

Browse files
committed
update concept-businessCard
1 parent 3d6f060 commit 3172f28

File tree

8 files changed

+168
-65
lines changed

8 files changed

+168
-65
lines changed

articles/applied-ai-services/form-recognizer/concept-business-card.md

Lines changed: 122 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,43 +7,65 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: conceptual
10-
ms.date: 10/14/2022
10+
ms.date: 11/10/2022
1111
ms.author: lajanuar
12-
monikerRange: '>=form-recog-2.1.0'
1312
recommendations: false
1413
---
1514
<!-- markdownlint-disable MD033 -->
1615

17-
# Business card data extraction
16+
# Azure Form Recognizer Business Card model
1817

19-
[!INCLUDE [applies to v3.0 and v2.1](includes/applies-to-v3-0-and-v2-1.md)]
18+
The business card model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to analyze and extract key information from business card images. The API analyzes printed business cards; extracts key information such as first name, last name, company name, email address, and phone number; and returns a structured JSON data representation.
2019

21-
## How business card data extraction works
20+
::: moniker range="form-recog-3.0.0"
21+
[!INCLUDE [applies to v3.0](includes/applies-to-v3-0.md)]
22+
::: moniker-end
2223

23-
Business cards are a great way of representing a business or a professional. The company logo, fonts and background images found in business cards help the company branding and differentiate it from others. Applying OCR and machine-learning based techniques to automate scanning of business cards is a common image processing scenario. Enterprise systems used by sales and marketing teams typically have business card data extraction capability integrated into them for the benefit of their users.
24+
::: moniker range="form-recog-2.1.0"
25+
[!INCLUDE [applies to v2.1](includes/applies-to-v2-1.md)]
26+
::: moniker-end
2427

25-
## Form Recognizer Business Card model
28+
## Business card data extraction works
2629

27-
The business card model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to analyze and extract key information from business card images. The API analyzes printed business cards; extracts key information such as first name, last name, company name, email address, and phone number; and returns a structured JSON data representation.
30+
Business cards are a great way of representing a business or a professional. The company logo, fonts and background images found in business cards help the company branding and differentiate it from others. Applying OCR and machine-learning based techniques to automate scanning of business cards is a common image processing scenario. Enterprise systems used by sales and marketing teams typically have business card data extraction capability integrated into them for the benefit of their users.
2831

32+
::: moniker range="form-recog-3.0.0"
2933
***Sample business card processed with [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=businessCard)***
3034

31-
:::image type="content" source="./media/studio/overview-business-card-studio.png" alt-text="sample business card" lightbox="./media/overview-business-card.jpg":::
35+
:::image type="content" source="media/studio/overview-business-card-studio.png" alt-text="sample business card" lightbox="./media/overview-business-card.jpg":::
36+
37+
::: moniker-end
38+
39+
::: moniker range="form-recog-2.1.0"
40+
41+
***Sample business processed with [Form Recognizer sample labeling tool](https://fott-2-1.azurewebsites.net/)***
42+
43+
:::image type="content" source="media/business-card-example.jpg" alt-text="sample business card":::
44+
45+
::: moniker-end
3246

3347
## Development options
3448

49+
::: moniker range="form-recog-3.0.0"
50+
3551
The following tools are supported by Form Recognizer v3.0:
3652

3753
| Feature | Resources | Model ID |
3854
|----------|-------------|-----------|
3955
|**Business card model**| <ul><li>[**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com)</li><li>[**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</li><li>[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true)</li><li>[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true)</li><li>[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true)</li><li>[**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true)</li></ul>|**prebuilt-businessCard**|
4056

57+
::: moniker-end
58+
59+
::: moniker range="form-recog-2.1.0"
60+
4161
The following tools are supported by Form Recognizer v2.1:
4262

4363
| Feature | Resources |
4464
|----------|-------------------------|
4565
|**Business card model**| <ul><li>[**Form Recognizer labeling tool**](https://fott-2-1.azurewebsites.net/prebuilts-analyze)</li><li>[**REST API**](/azure/applied-ai-services/form-recognizer/how-to-guides/use-sdk-rest-api?view=form-recog-2.1.0&preserve-view=true&tabs=windows&pivots=programming-language-rest-api#analyze-business-cards)</li><li>[**Client-library SDK**](/azure/applied-ai-services/form-recognizer/how-to-guides/v2-1-sdk-rest-api)</li><li>[**Form Recognizer Docker container**](containers/form-recognizer-container-install-run.md?tabs=business-card#run-the-container-with-the-docker-compose-up-command)</li></ul>|
4666

67+
::: moniker-end
68+
4769
### Try business card data extraction
4870

4971
See how data, including name, job title, address, email, and company name, is extracted from business cards using the Form Recognizer Studio or our Sample Labeling tool. You'll need the following resources:
@@ -54,6 +76,8 @@ See how data, including name, job title, address, email, and company name, is ex
5476

5577
:::image type="content" source="media/containers/keys-and-endpoint.png" alt-text="Screenshot: keys and endpoint location in the Azure portal.":::
5678

79+
::: moniker range="form-recog-3.0.0"
80+
5781
#### Form Recognizer Studio
5882

5983
> [!NOTE]
@@ -70,20 +94,54 @@ See how data, including name, job title, address, email, and company name, is ex
7094
> [!div class="nextstepaction"]
7195
> [Try Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=businessCard)
7296
73-
## Input requirements
97+
::: moniker-end
98+
99+
::: moniker range="form-recog-2.1.0"
100+
101+
## Form Recognizer sample labeling tool
102+
103+
1. Navigate to the [Form Recognizer Sample Tool](https://fott-2-1.azurewebsites.net/).
104+
105+
1. On the sample tool home page, select **Use prebuilt model to get data**.
106+
107+
:::image type="content" source="media/label-tool/prebuilt-1.jpg" alt-text="Analyze results of Form Recognizer Layout":::
108+
109+
1. Select the **Form Type** to analyze from the dropdown window.
110+
111+
1. Choose a URL for the file you would like to analyze from the below options:
112+
113+
* [**Sample invoice document**](https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/invoice_sample.jpg).
114+
* [**Sample ID document**](https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/DriverLicense.png).
115+
* [**Sample receipt image**](https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/contoso-allinone.jpg).
116+
* [**Sample business card image**](https://raw.githubusercontent.com/Azure/azure-sdk-for-python/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_forms/business_cards/business-card-english.jpg).
117+
118+
1. In the **Source** field, select **URL** from the dropdown menu, paste the selected URL, and select the **Fetch** button.
74119

75-
* For best results, provide one clear photo or high-quality scan per document.
76-
* Supported file formats: JPEG/JPG, PNG, BMP, TIFF, and PDF (text-embedded or scanned). Text-embedded PDFs are best to eliminate the possibility of error in character extraction and location.
77-
* For PDF and TIFF, up to 2000 pages can be processed (with a free tier subscription, only the first two pages are processed).
78-
* The file size must be less than 500 MB for paid (S0) tier and 4 MB for free (F0) tier.
79-
* Image dimensions must be between 50 x 50 pixels and 10,000 x 10,000 pixels.
80-
* PDF dimensions are up to 17 x 17 inches, corresponding to Legal or A3 paper size, or smaller.
81-
* The total size of the training data is 500 pages or less.
82-
* If your PDFs are password-locked, you must remove the lock before submission.
120+
:::image type="content" source="media/label-tool/fott-select-url.png" alt-text="Screenshot of source location dropdown menu.":::
121+
122+
1. In the **Form recognizer service endpoint** field, paste the endpoint that you obtained with your Form Recognizer subscription.
123+
124+
1. In the **key** field, paste the key you obtained from your Form Recognizer resource.
125+
126+
:::image type="content" source="media/fott-select-form-type.png" alt-text="Screenshot: select form type dropdown window.":::
127+
128+
1. Select **Run analysis**. The Form Recognizer Sample Labeling tool will call the Analyze Prebuilt API and analyze the document.
129+
130+
1. View the results - see the key-value pairs extracted, line items, highlighted text extracted and tables detected.
131+
132+
:::image type="content" source="media/invoice-example-new.jpg" alt-text="Analyze Results of Form Recognizer invoice model":::
83133

84134
> [!NOTE]
85135
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) does not support the BMP file format. This is a limitation of the tool not the Form Recognizer Service.
86136
137+
::: moniker-end
138+
139+
## Input requirements
140+
141+
[!INCLUDE [input requirements](./includes/input-requirements.md)]
142+
143+
::: moniker range="form-recog-3.0.0"
144+
87145
## Supported languages and locales
88146

89147
>[!NOTE]
@@ -112,22 +170,59 @@ See how data, including name, job title, address, email, and company name, is ex
112170
| WorkPhones | Array of phone numbers | Work phone number(s) from business card | +1 xxx xxx xxxx |
113171
| OtherPhones | Array of phone numbers | Other phone number(s) from business card | +1 xxx xxx xxxx |
114172

115-
## Form Recognizer v3.0
173+
::: moniker-end
174+
175+
::: moniker range="form-recog-2.1.0"
116176

117-
Form Recognizer v3.0 introduces several new features and capabilities.
177+
### Fields extracted
178+
179+
|Name| Type | Description | Text |
180+
|:-----|:----|:----|:----|
181+
| ContactNames | array of objects | Contact name extracted from business card | [{ "FirstName": "John", "LastName": "Doe" }] |
182+
| FirstName | string | First (given) name of contact | "John" |
183+
| LastName | string | Last (family) name of contact | "Doe" |
184+
| CompanyNames | array of strings | Company name extracted from business card | ["Contoso"] |
185+
| Departments | array of strings | Department or organization of contact | ["R&D"] |
186+
| JobTitles | array of strings | Listed Job title of contact | ["Software Engineer"] |
187+
| Emails | array of strings | Contact email extracted from business card | ["[email protected]"] |
188+
| Websites | array of strings | Website extracted from business card | ["https://www.contoso.com"] |
189+
| Addresses | array of strings | Address extracted from business card | ["123 Main Street, Redmond, WA 98052"] |
190+
| MobilePhones | array of phone numbers | Mobile phone number extracted from business card | ["+19876543210"] |
191+
| Faxes | array of phone numbers | Fax phone number extracted from business card | ["+19876543211"] |
192+
| WorkPhones | array of phone numbers | Work phone number extracted from business card | ["+19876543231"] |
193+
| OtherPhones | array of phone numbers | Other phone number extracted from business card | ["+19876543233"] |
194+
195+
## Supported locales
196+
197+
**Pre-built business cards v2.1** supports the following locales:
198+
199+
* **en-us**
200+
* **en-au**
201+
* **en-ca**
202+
* **en-gb**
203+
* **en-in**
204+
205+
### Migration guide and REST API v3.0
118206

119207
* Follow our [**Form Recognizer v3.0 migration guide**](v3-migration-guide.md) to learn how to use the v3.0 version in your applications and workflows.
120208

121-
* Explore our [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument) to learn more about the v3.0 version and new capabilities.
209+
::: moniker-end
122210

123211
## Next steps
124212

125-
* Complete a Form Recognizer quickstart:
213+
::: moniker range="form-recog-3.0.0"
126214

127-
> [!div class="nextstepaction"]
128-
> [Form Recognizer quickstart](/azure/applied-ai-services/form-recognizer/how-to-guides/v2-1-sdk-rest-api)
215+
* [Learn how to process your own forms and documents](quickstarts/try-v3-form-recognizer-studio.md) with the [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio)
129216

130-
* Explore our REST API:
217+
* Complete a [Form Recognizer quickstart](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) and get started creating a document processing app in the development language of your choice.
218+
219+
::: moniker-end
220+
221+
::: moniker range="form-recog-2.1.0"
222+
223+
* [Learn how to process your own forms and documents](quickstarts/try-sample-label-tool.md) with the [Form Recognizer sample labeling tool](https://fott-2-1.azurewebsites.net/)
224+
225+
* Complete a [Form Recognizer quickstart](quickstarts/get-started-sdks-rest-api.md?view=form-recog-2.1.0&preserve-view=true) and get started creating a document processing app in the development language of your choice.
226+
227+
::: moniker-end
131228

132-
> [!div class="nextstepaction"]
133-
> [Form Recognizer API v3.0](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)

articles/applied-ai-services/form-recognizer/concept-general-document.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@ recommendations: false
1414
---
1515
<!-- markdownlint-disable MD033 -->
1616

17-
# General key-value extraction with General Document model
17+
# Azure Form Recognizer general document model
1818

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

2121
The General document v3.0 model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to extract key-value pairs, tables, and selection marks from documents. General document is only available with the v3.0 API. For more information on using the v3.0 API, see our [migration guide](v3-migration-guide.md).
2222

23+
### Key-value extraction
24+
2325
The general document API supports most form types and will analyze your documents and extract keys and associated values. It's ideal for extracting common key-value pairs from documents. You can use the general document model as an alternative to training a custom model without labels.
2426

2527
> [!NOTE]

articles/applied-ai-services/form-recognizer/concept-id-document.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: conceptual
10-
ms.date: 10/27/2022
10+
ms.date: 11/10/2022
1111
ms.author: lajanuar
1212
recommendations: false
1313
ms.custom: references.regions
1414
---
1515
<!-- markdownlint-disable MD033 -->
1616

17-
# Identity document (ID) processing
17+
# Azure Form Recognizer Identity document (ID) model
18+
19+
The Form Recognizer Identity document (ID) model combines Optical Character Recognition (OCR) with deep learning models to analyze and extract key information from identity documents: US Drivers Licenses (all 50 states and District of Columbia), international passport biographical pages, US state IDs, social security cards, and permanent resident cards and more. The API analyzes identity documents, extracts key information, and returns a structured JSON data representation.
1820

1921
::: moniker range="form-recog-3.0.0"
2022
[!INCLUDE [applies to v3.0](includes/applies-to-v3-0.md)]
@@ -24,16 +26,12 @@ ms.custom: references.regions
2426
[!INCLUDE [applies to v2.1](includes/applies-to-v2-1.md)]
2527
::: moniker-end
2628

27-
## What is identity document (ID) processing
29+
## Identity document (ID) processing
2830

2931
Identity document (ID) processing involves extraction of data from identity documents whether manually or using OCR based techniques. Examples of identity documents include passports, driver licenses, resident cards, and national identity cards like the social security card in the US. It is an important step in any business process that requires some proof of identity. Examples include customer verification in banks and other financial institutions, mortgage applications, medical visits, claim processing, hospitality industry, and more. Individuals provide some proof of their identity via driver licenses, passports, and other similar documents so that the business can efficiently verify them before providing services and benefits.
3032

3133
::: moniker range="form-recog-3.0.0"
3234

33-
## Form Recognizer Identity document (ID) model
34-
35-
The Form Recognizer Identity document (ID) model combines Optical Character Recognition (OCR) with deep learning models to analyze and extract key information from identity documents: US Drivers Licenses (all 50 states and District of Columbia), international passport biographical pages, US state IDs, social security cards, and permanent resident cards and more. The API analyzes identity documents, extracts key information, and returns a structured JSON data representation.
36-
3735
***Sample U.S. Driver's License processed with [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=idDocument)***
3836

3937
:::image type="content" source="media/studio/analyze-drivers-license.png" alt-text="Image of a sample driver's license.":::

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: conceptual
10-
ms.date: 11/08/2022
10+
ms.date: 11/10/2022
1111
ms.author: lajanuar
1212
recommendations: false
1313
---
@@ -39,7 +39,7 @@ Automated invoice processing is the process of extracting key accounts payable f
3939

4040
::: moniker range="form-recog-2.1.0"
4141

42-
**Sample invoice processed with [Form Recognizer sample labeling tool](https://fott-2-1.azurewebsites.net/connections)**:
42+
**Sample invoice processed with [Form Recognizer sample labeling tool](https://fott-2-1.azurewebsites.net)**:
4343

4444
:::image type="content" source="media/invoice-example-new.jpg" alt-text="Screenshot of a processed Contoso invoice.":::
4545

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: conceptual
10-
ms.date: 11/08/2022
10+
ms.date: 11/10/2022
1111
ms.author: lajanuar
1212
recommendations: false
1313
---
1414

15-
# Document layout analysis
15+
# Azure Form Recognizer layout model
16+
17+
The Form Recognizer Layout is an advanced machine-learning based document layout analysis model available in the Form Recognizer cloud API. In the version v2.1, the document layout model extracted text lines, words, tables, and selection marks.
1618

1719
::: moniker range="form-recog-3.0.0"
1820
[!INCLUDE [applies to v3.0](includes/applies-to-v3-0.md)]
@@ -22,22 +24,29 @@ recommendations: false
2224
[!INCLUDE [applies to v2.1](includes/applies-to-v2-1.md)]
2325
::: moniker-end
2426

25-
## What is document layout analysis?
27+
## Document layout analysis
2628

2729
Document structure and layout analysis is the process of analyzing a document to extract regions of interest and their inter-relationships. The goal is to extract text and structural elements from the page for building better semantic understanding models. For all extracted text, there are two types of roles that text plays in a document layout. Text, tables, and selection marks are examples of geometric roles. Titles, headings, and footers are examples of logical roles. For example. a reading system requires differentiating text regions from non-textual ones along with their reading order.
2830

2931
The following illustration shows the typical components in an image of a sample page.
3032

3133
:::image type="content" source="media/document-layout-example.png" alt-text="Illustration of document layout example.":::
3234

33-
## Form Recognizer Layout model
34-
35-
The Form Recognizer Layout is an advanced machine-learning based document layout analysis model available in the Form Recognizer cloud API. In the version v2.1, the document layout model extracted text lines, words, tables, and selection marks.
35+
::: moniker range="form-recog-3.0.0"
3636

3737
***Sample form processed with [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio/layout)***
3838

3939
:::image type="content" source="media/studio/form-recognizer-studio-layout-newspaper.png" alt-text="Screenshot of sample newspaper page processed using Form Recognizer studio":::
4040

41+
::: moniker-end
42+
43+
::: moniker range="form-recog-2.1.0"
44+
45+
**Sample document processed with [Form Recognizer sample labeling tool layout model](https://fott-2-1.azurewebsites.net/layout-analyze)**:
46+
47+
:::image type="content" source="media/layout-tool-example.jpg" alt-text="Screenshot of a document processed with the layout model.":::
48+
::: moniker-end
49+
4150
## Supported document types
4251

4352
| **Model** | **Images** | **PDF** | **TIFF** |

0 commit comments

Comments
 (0)