Skip to content

Commit 1cc68c6

Browse files
[formrecognizer] Readme fixes (Azure#18352)
* readme fixes * fix snippet link
1 parent 0bc29bb commit 1cc68c6

File tree

2 files changed

+15
-85
lines changed

2 files changed

+15
-85
lines changed

sdk/formrecognizer/azure-ai-formrecognizer/README.md

Lines changed: 14 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ from form documents. It includes the following main functionalities:
99
* Receipt model - Recognize data from sales receipts using a prebuilt model.
1010
* Business card model - Recognize data from business cards using a prebuilt model.
1111
* Invoice model - Recognize data from invoices using a prebuilt model.
12-
* Id document model - Recognize data from id documents using a prebuilt model.
12+
* ID document model - Recognize data from ID documents using a prebuilt model.
1313

1414
[Source code][python-fr-src] | [Package (PyPI)][python-fr-pypi] | [API reference documentation][python-fr-ref-docs]| [Product documentation][python-fr-product-docs] | [Samples][python-fr-samples]
1515

@@ -139,7 +139,7 @@ form_recognizer_client = FormRecognizerClient(
139139
- Sales receipts. See fields found on a receipt [here][service_recognize_receipt].
140140
- Business cards. See fields found on a business card [here][service_recognize_business_cards].
141141
- Invoices. See fields found on an invoice [here][service_recognize_invoice].
142-
- Id documents. See fields found on an id document [here][service_recognize_id_documents].
142+
- ID documents. See fields found on an ID document [here][service_recognize_id_documents].
143143
- Recognizing form content, including tables, lines, words, and selection marks, without the need to train a model. Form content is returned in a collection of `FormPage` objects.
144144

145145
Sample code snippets are provided to illustrate using a FormRecognizerClient [here](#recognize-forms-using-a-custom-model "Recognize Forms Using a Custom Model").
@@ -174,10 +174,7 @@ The following section provides several code snippets covering some of the most c
174174

175175
* [Recognize Forms Using a Custom Model](#recognize-forms-using-a-custom-model "Recognize Forms Using a Custom Model")
176176
* [Recognize Content](#recognize-content "Recognize Content")
177-
* [Recognize Receipts](#recognize-receipts "Recognize receipts")
178-
* [Recognize Business Cards](#recognize-business-cards "Recognize business cards")
179-
* [Recognize Invoices](#recognize-invoices "Recognize invoices")
180-
* [Recognize Id Documents](#recognize-id-documents "Recognize id documents")
177+
* [Using Prebuilt Models](#using-prebuilt-models "Using Prebuilt Models")
181178
* [Train a Model](#train-a-model "Train a model")
182179
* [Manage Your Models](#manage-your-models "Manage Your Models")
183180

@@ -260,8 +257,10 @@ for content in form_pages:
260257
))
261258
```
262259

263-
### Recognize Receipts
264-
Recognize data from sales receipts using a prebuilt model. Receipt fields recognized by the service can be found [here][service_recognize_receipt].
260+
### Using Prebuilt Models
261+
Extract fields from certain types of common forms such as receipts, invoices, business cards, and identity documents using prebuilt models provided by the Form Recognizer service.
262+
263+
For example, to extract fields from a sales receipt, use the prebuilt receipt model provided by the `begin_recognize_receipts` method:
265264

266265
```python
267266
from azure.ai.formrecognizer import FormRecognizerClient
@@ -290,81 +289,12 @@ for receipt in result:
290289
print("{}: {} has confidence {}".format(name, field.value, field.confidence))
291290
```
292291

293-
### Recognize Business Cards
294-
Recognize data from business cards using a prebuilt model. Business card fields recognized by the service can be found [here][service_recognize_business_cards].
295-
296-
```python
297-
from azure.ai.formrecognizer import FormRecognizerClient
298-
from azure.core.credentials import AzureKeyCredential
299-
300-
endpoint = "https://<region>.api.cognitive.microsoft.com/"
301-
credential = AzureKeyCredential("<api_key>")
302-
303-
form_recognizer_client = FormRecognizerClient(endpoint, credential)
304-
305-
with open("<path to your business card>", "rb") as fd:
306-
business_card = fd.read()
307-
308-
poller = form_recognizer_client.begin_recognize_business_cards(business_card)
309-
result = poller.result()
310-
311-
for business_card in result:
312-
for name, field in business_card.fields.items():
313-
if name == "ContactNames":
314-
print("ContactNames:")
315-
for items in field.value:
316-
for item_name, item in items.value.items():
317-
print("...{}: {} has confidence {}".format(item_name, item.value, item.confidence))
318-
else:
319-
for item in field.value:
320-
print("{}: {} has confidence {}".format(item.name, item.value, item.confidence))
321-
```
322-
323-
### Recognize Invoices
324-
Recognize data from invoices using a prebuilt model. Invoice fields recognized by the service can be found [here][service_recognize_invoice].
325-
326-
```python
327-
from azure.ai.formrecognizer import FormRecognizerClient
328-
from azure.core.credentials import AzureKeyCredential
329-
330-
endpoint = "https://<region>.api.cognitive.microsoft.com/"
331-
credential = AzureKeyCredential("<api_key>")
332-
333-
form_recognizer_client = FormRecognizerClient(endpoint, credential)
334-
335-
with open("<path to your invoice>", "rb") as fd:
336-
invoice = fd.read()
337-
338-
poller = form_recognizer_client.begin_recognize_invoices(invoice)
339-
result = poller.result()
340-
341-
for invoice in result:
342-
for name, field in invoice.fields.items():
343-
print("{}: {} has confidence {}".format(name, field.value, field.confidence))
344-
```
345-
346-
### Recognize Id documents
347-
Recognize data from id documents using a prebuilt model. Id document fields recognized by the service can be found [here][service_recognize_id_documents].
292+
You are not limited to receipts! There are a few prebuilt models to choose from, each of which has its own set of supported fields:
293+
- Analyze receipts through the `begin_recognize_receipts` method (fields recognized by the service can be found [here][service_recognize_receipt])
294+
- Analyze business cards through the `begin_recognize_business_cards` method (fields recognized by the service can be found [here][service_recognize_business_cards]).
295+
- Analyze invoices through the `begin_recognize_invoices` method (fields recognized by the service can be found [here][service_recognize_invoice]).
296+
- Analyze identity documents through the `begin_recognize_id_documents` method (fields recognized by the service can be found [here][service_recognize_id_documents]).
348297

349-
```python
350-
from azure.ai.formrecognizer import FormRecognizerClient
351-
from azure.core.credentials import AzureKeyCredential
352-
353-
endpoint = "https://<region>.api.cognitive.microsoft.com/"
354-
credential = AzureKeyCredential("<api_key>")
355-
356-
form_recognizer_client = FormRecognizerClient(endpoint, credential)
357-
358-
with open("<path to your id document>", "rb") as fd:
359-
id_document = fd.read()
360-
361-
poller = form_recognizer_client.begin_recognize_id_documents(id_document)
362-
result = poller.result()
363-
364-
for id_document in result:
365-
for name, field in id_document.fields.items():
366-
print("{}: {} has confidence {}".format(name, field.value, field.confidence))
367-
```
368298

369299
### Train a model
370300
Train a custom model on your own form type. The resulting model can be used to recognize values from the types of forms it was trained on.
@@ -497,7 +427,7 @@ These code samples show common scenario operations with the Azure Form Recognize
497427
* Recognize receipts from a URL: [sample_recognize_receipts_from_url.py][sample_recognize_receipts_from_url]
498428
* Recognize business cards: [sample_recognize_business_cards.py][sample_recognize_business_cards]
499429
* Recognize invoices: [sample_recognize_invoices.py][sample_recognize_invoices]
500-
* Recognize id documents: [sample_recognize_id_documents.py][sample_recognize_id_documents]
430+
* Recognize ID documents: [sample_recognize_id_documents.py][sample_recognize_id_documents]
501431
* Recognize content: [sample_recognize_content.py][sample_recognize_content]
502432
* Recognize custom forms: [sample_recognize_custom_forms.py][sample_recognize_custom_forms]
503433
* Train a model without labels: [sample_train_model_without_labels.py][sample_train_model_without_labels]
@@ -516,7 +446,7 @@ are found under the `azure.ai.formrecognizer.aio` namespace.
516446
* Recognize receipts from a URL: [sample_recognize_receipts_from_url_async.py][sample_recognize_receipts_from_url_async]
517447
* Recognize business cards: [sample_recognize_business_cards_async.py][sample_recognize_business_cards_async]
518448
* Recognize invoices: [sample_recognize_invoices_async.py][sample_recognize_invoices_async]
519-
* Recognize id documents: [sample_recognize_id_documents_async.py][sample_recognize_id_documents_async]
449+
* Recognize ID documents: [sample_recognize_id_documents_async.py][sample_recognize_id_documents_async]
520450
* Recognize content: [sample_recognize_content_async.py][sample_recognize_content_async]
521451
* Recognize custom forms: [sample_recognize_custom_forms_async.py][sample_recognize_custom_forms_async]
522452
* Train a model without labels: [sample_train_model_without_labels_async.py][sample_train_model_without_labels_async]

sdk/formrecognizer/azure-ai-formrecognizer/samples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ All of these samples need the endpoint to your Form Recognizer resource ([instru
2525
|[sample_recognize_receipts.py][sample_recognize_receipts] and [sample_recognize_receipts_async.py][sample_recognize_receipts_async]|Recognize data from a file of a sales receipt using a prebuilt model|
2626
|[sample_recognize_receipts_from_url.py][sample_recognize_receipts_from_url] and [sample_recognize_receipts_from_url_async.py][sample_recognize_receipts_from_url_async]|Recognize data from a URL of a sales receipt using a prebuilt model|
2727
|[sample_recognize_business_cards.py][sample_recognize_business_cards] and [sample_recognize_business_cards_async.py][sample_recognize_business_cards_async]|Recognize data from a file of a business card using a prebuilt model|
28-
|[sample_recognize_id_documents.py][sample_recognize_id_documents] and [sample_recognize_id_documents_async.py][sample_recognize_id_documents_async]|Recognize data from a file of an id document using a prebuilt model|
28+
|[sample_recognize_id_documents.py][sample_recognize_id_documents] and [sample_recognize_id_documents_async.py][sample_recognize_id_documents_async]|Recognize data from a file of an ID document using a prebuilt model|
2929
|[sample_recognize_invoices.py][sample_recognize_invoices] and [sample_recognize_invoices_async.py][sample_recognize_invoices_async]|Recognize data from a file of an invoice using a prebuilt model|
3030
|[sample_recognize_custom_forms.py][sample_recognize_custom_forms] and [sample_recognize_custom_forms_async.py][sample_recognize_custom_forms_async]|Recognize forms with your custom model|
3131
|[sample_train_model_without_labels.py][sample_train_model_without_labels] and [sample_train_model_without_labels_async.py][sample_train_model_without_labels_async]|Train a custom model with unlabeled data|

0 commit comments

Comments
 (0)