Microsoft Azure Form Recognizer Client Library for Python
Project description
Azure Form Recognizer client library for Python
Azure Cognitive Services Form Recognizer is a cloud service that uses machine learning to recognize text and table data from form documents. It includes the following main functionalities:
- Custom models - Recognize field values and table data from forms. These models are trained with your own data, so they're tailored to your forms.
- Content API - Recognize text, table structures, and selection marks, along with their bounding box coordinates, from documents. Corresponds to the REST service's Layout API.
- Prebuilt models - Recognize data using the following prebuilt models
- Receipt model - Recognize data from sales receipts using a prebuilt model.
- Business card model - Recognize data from business cards using a prebuilt model.
- Invoice model - Recognize data from invoices using a prebuilt model.
Source code | Package (PyPI) | API reference documentation| Product documentation | Samples
Getting started
Prerequisites
- Python 2.7, or 3.5 or later is required to use this package.
- You must have an Azure subscription and a Cognitive Services or Form Recognizer resource to use this package.
Install the package
Install the Azure Form Recognizer client library for Python with pip:
pip install azure-ai-formrecognizer --pre
Note: This version of the client library defaults to the v2.1-preview version of the service
This table shows the relationship between SDK versions and supported API versions of the service
| SDK version | Supported API version of service |
|---|---|
3.0.0 - Latest GA release (can be installed by removing the --pre flag) |
2.0 |
| 3.1.0b3 - Latest release (beta) | 2.0, 2.1-preview |
Create a Form Recognizer resource
Form Recognizer supports both multi-service and single-service access. 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.
You can create the resource using
Option 1: Azure Portal
Option 2: Azure CLI. Below is an example of how you can create a Form Recognizer resource using the CLI:
# Create a new resource group to hold the form recognizer resource -
# if using an existing resource group, skip this step
az group create --name my-resource-group --location westus2
# Create form recognizer
az cognitiveservices account create \
--name form-recognizer-resource \
--resource-group my-resource-group \
--kind FormRecognizer \
--sku F0 \
--location westus2 \
--yes
Authenticate the client
In order to interact with the Form Recognizer service, you will need to create an instance of a client. An endpoint and credential are necessary to instantiate the client object.
Looking up the endpoint
You can find the endpoint for your Form Recognizer resource using the Azure Portal or Azure CLI:
# Get the endpoint for the form recognizer resource
az cognitiveservices account show --name "resource-name" --resource-group "resource-group-name" --query "properties.endpoint"
Get the API key
The API key can be found in the Azure Portal or by running the following Azure CLI command:
az cognitiveservices account keys list --name "resource-name" --resource-group "resource-group-name"
Create the client with AzureKeyCredential
To use an API key as the credential parameter,
pass the key as a string into an instance of AzureKeyCredential.
from azure.core.credentials import AzureKeyCredential
from azure.ai.formrecognizer import FormRecognizerClient
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_recognizer_client = FormRecognizerClient(endpoint, credential)
Create the client with an Azure Active Directory credential
AzureKeyCredential authentication is used in the examples in this getting started guide, but you can also
authenticate with Azure Active Directory using the azure-identity library.
Note that regional endpoints do not support AAD authentication. Create a custom subdomain
name for your resource in order to use this type of authentication.
To use the DefaultAzureCredential type shown below, or other credential types provided
with the Azure SDK, please install the azure-identity package:
pip install azure-identity
You will also need to register a new AAD application and grant access to
Form Recognizer by assigning the "Cognitive Services User" role to your service principal.
Once completed, set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.
from azure.identity import DefaultAzureCredential
from azure.ai.formrecognizer import FormRecognizerClient
credential = DefaultAzureCredential()
form_recognizer_client = FormRecognizerClient(
endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/",
credential=credential
)
Key concepts
FormRecognizerClient
FormRecognizerClient provides operations for:
- Recognizing form fields and content using custom models trained to recognize your custom forms. These values are returned in a collection of
RecognizedFormobjects. - Recognizing common fields from the following form types using prebuilt models. These fields and metadata are returned in a collection of
RecognizedFormobjects. - 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
FormPageobjects.
Sample code snippets are provided to illustrate using a FormRecognizerClient here.
FormTrainingClient
FormTrainingClient provides operations for:
- Training custom models without labels to recognize all fields and values found in your custom forms. A
CustomFormModelis returned indicating the form types the model will recognize, and the fields it will extract for each form type. See the service documentation for a more detailed explanation. - Training custom models with labels to recognize specific fields, selection marks, and values you specify by labeling your custom forms. A
CustomFormModelis returned indicating the fields the model will extract, as well as the estimated accuracy for each field. See the service documentation for a more detailed explanation. - Managing models created in your account.
- Copying a custom model from one Form Recognizer resource to another.
- Creating a composed model from a collection of existing trained models with labels.
Please note that models can also be trained using a graphical user interface such as the Form Recognizer Labeling Tool.
Sample code snippets are provided to illustrate using a FormTrainingClient here.
Long-Running Operations
Long-running operations are operations which consist of an initial request sent to the service to start an operation, followed by polling the service at intervals to determine whether the operation has completed or failed, and if it has succeeded, to get the result.
Methods that train models, recognize values from forms, or copy/compose models are modeled as long-running operations.
The client exposes a begin_<method-name> method that returns an LROPoller or AsyncLROPoller. Callers should wait
for the operation to complete by calling result() on the poller object returned from the begin_<method-name> method.
Sample code snippets are provided to illustrate using long-running operations below.
Examples
The following section provides several code snippets covering some of the most common Form Recognizer tasks, including:
- Recognize Forms Using a Custom Model
- Recognize Content
- Recognize Receipts
- Recognize Business Cards
- Recognize Invoices
- Train a Model
- Manage Your Models
Recognize Forms Using a Custom Model
Recognize name/value pairs and table data from forms. These models are trained with your own data, so they're tailored to your forms. For best results, you should only recognize forms of the same form type that the custom model was trained on.
from azure.ai.formrecognizer import FormRecognizerClient
from azure.core.credentials import AzureKeyCredential
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_recognizer_client = FormRecognizerClient(endpoint, credential)
model_id = "<your custom model id>"
with open("<path to your form>", "rb") as fd:
form = fd.read()
poller = form_recognizer_client.begin_recognize_custom_forms(model_id=model_id, form=form)
result = poller.result()
for recognized_form in result:
print("Form type: {}".format(recognized_form.form_type))
print("Form type confidence: {}".format(recognized_form.form_type_confidence))
print("Form was analyzed using model with ID: {}".format(recognized_form.model_id))
for name, field in recognized_form.fields.items():
print("Field '{}' has label '{}' with value '{}' and a confidence score of {}".format(
name,
field.label_data.text if field.label_data else name,
field.value,
field.confidence
))
Alternatively, a form URL can also be used to recognize custom forms using the begin_recognize_custom_forms_from_url method.
The _from_url methods exist for all the recognize methods.
form_url = "<url_of_the_form>"
poller = form_recognizer_client.begin_recognize_custom_forms_from_url(model_id=model_id, form_url=form_url)
result = poller.result()
Recognize Content
Recognize text, selection marks, and table structures, along with their bounding box coordinates, from documents.
from azure.ai.formrecognizer import FormRecognizerClient
from azure.core.credentials import AzureKeyCredential
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_recognizer_client = FormRecognizerClient(endpoint, credential)
with open("<path to your form>", "rb") as fd:
form = fd.read()
poller = form_recognizer_client.begin_recognize_content(form)
form_pages = poller.result()
for content in form_pages:
for table in content.tables:
print("Table found on page {}:".format(table.page_number))
print("Table location {}:".format(table.bounding_box))
for cell in table.cells:
print("Cell text: {}".format(cell.text))
print("Location: {}".format(cell.bounding_box))
print("Confidence score: {}\n".format(cell.confidence))
if content.selection_marks:
print("Selection marks found on page {}:".format(content.page_number))
for selection_mark in content.selection_marks:
print("Selection mark is '{}' within bounding box '{}' and has a confidence of {}".format(
selection_mark.state,
selection_mark.bounding_box,
selection_mark.confidence
))
Recognize Receipts
Recognize data from sales receipts using a prebuilt model. Receipt fields recognized by the service can be found here.
from azure.ai.formrecognizer import FormRecognizerClient
from azure.core.credentials import AzureKeyCredential
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_recognizer_client = FormRecognizerClient(endpoint, credential)
with open("<path to your receipt>", "rb") as fd:
receipt = fd.read()
poller = form_recognizer_client.begin_recognize_receipts(receipt)
result = poller.result()
for receipt in result:
for name, field in receipt.fields.items():
if name == "Items":
print("Receipt Items:")
for idx, items in enumerate(field.value):
print("...Item #{}".format(idx+1))
for item_name, item in items.value.items():
print("......{}: {} has confidence {}".format(item_name, item.value, item.confidence))
else:
print("{}: {} has confidence {}".format(name, field.value, field.confidence))
Recognize Business Cards
Recognize data from business cards using a prebuilt model. Business card fields recognized by the service can be found here.
from azure.ai.formrecognizer import FormRecognizerClient
from azure.core.credentials import AzureKeyCredential
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_recognizer_client = FormRecognizerClient(endpoint, credential)
with open("<path to your business card>", "rb") as fd:
business_card = fd.read()
poller = form_recognizer_client.begin_recognize_business_cards(business_card)
result = poller.result()
for business_card in result:
for name, field in business_card.fields.items():
if name == "ContactNames":
print("ContactNames:")
for items in field.value:
for item_name, item in items.value.items():
print("...{}: {} has confidence {}".format(item_name, item.value, item.confidence))
else:
for item in field.value:
print("{}: {} has confidence {}".format(item.name, item.value, item.confidence))
Recognize Invoices
Recognize data from invoices using a prebuilt model. Invoice fields recognized by the service can be found here.
from azure.ai.formrecognizer import FormRecognizerClient
from azure.core.credentials import AzureKeyCredential
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_recognizer_client = FormRecognizerClient(endpoint, credential)
with open("<path to your invoice>", "rb") as fd:
invoice = fd.read()
poller = form_recognizer_client.begin_recognize_invoices(invoice)
result = poller.result()
for invoice in result:
for name, field in invoice.fields.items():
print("{}: {} has confidence {}".format(name, field.value, field.confidence))
Train a model
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. Provide a container SAS URL to your Azure Storage Blob container where you're storing the training documents. If training files are within a subfolder in the container, use the prefix keyword argument to specify under which folder to train.
More details on setting up a container and required file structure can be found in the service documentation.
from azure.ai.formrecognizer import FormTrainingClient
from azure.core.credentials import AzureKeyCredential
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_training_client = FormTrainingClient(endpoint, credential)
container_sas_url = "<container-sas-url>" # training documents uploaded to blob storage
poller = form_training_client.begin_training(
container_sas_url, use_training_labels=False, model_name="my first model"
)
model = poller.result()
# Custom model information
print("Model ID: {}".format(model.model_id))
print("Model name: {}".format(model.model_name))
print("Is composed model?: {}".format(model.properties.is_composed_model))
print("Status: {}".format(model.status))
print("Training started on: {}".format(model.training_started_on))
print("Training completed on: {}".format(model.training_completed_on))
print("\nRecognized fields:")
for submodel in model.submodels:
print(
"The submodel with form type '{}' and model ID '{}' has recognized the following fields: {}".format(
submodel.form_type, submodel.model_id,
", ".join(
[
field.label if field.label else name
for name, field in submodel.fields.items()
]
),
)
)
# Training result information
for doc in model.training_documents:
print("Document name: {}".format(doc.name))
print("Document status: {}".format(doc.status))
print("Document page count: {}".format(doc.page_count))
print("Document errors: {}".format(doc.errors))
Manage Your Models
Manage the custom models attached to your account.
from azure.ai.formrecognizer import FormTrainingClient
from azure.core.credentials import AzureKeyCredential
from azure.core.exceptions import ResourceNotFoundError
endpoint = "https://<region>.api.cognitive.microsoft.com/"
credential = AzureKeyCredential("<api_key>")
form_training_client = FormTrainingClient(endpoint, credential)
account_properties = form_training_client.get_account_properties()
print("Our account has {} custom models, and we can have at most {} custom models".format(
account_properties.custom_model_count, account_properties.custom_model_limit
))
# Here we get a paged list of all of our custom models
custom_models = form_training_client.list_custom_models()
print("We have models with the following ids: {}".format(
", ".join([m.model_id for m in custom_models])
))
# Replace with the custom model ID from the "Train a model" sample
model_id = "<model_id from the Train a Model sample>"
custom_model = form_training_client.get_custom_model(model_id=model_id)
print("Model ID: {}".format(custom_model.model_id))
print("Model name: {}".format(custom_model.model_name))
print("Is composed model?: {}".format(custom_model.properties.is_composed_model))
print("Status: {}".format(custom_model.status))
print("Training started on: {}".format(custom_model.training_started_on))
print("Training completed on: {}".format(custom_model.training_completed_on))
# Finally, we will delete this model by ID
form_training_client.delete_model(model_id=custom_model.model_id)
try:
form_training_client.get_custom_model(model_id=custom_model.model_id)
except ResourceNotFoundError:
print("Successfully deleted model with id {}".format(custom_model.model_id))
Troubleshooting
General
Form Recognizer client library will raise exceptions defined in Azure Core.
Logging
This library uses the standard logging library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level.
Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on the client or per-operation with the logging_enable keyword argument.
See full SDK logging documentation with examples here.
Optional Configuration
Optional keyword arguments can be passed in at the client and per-operation level. The azure-core reference documentation describes available configurations for retries, logging, transport protocols, and more.
Next steps
The following section provides several code snippets illustrating common patterns used in the Form Recognizer Python API.
More sample code
These code samples show common scenario operations with the Azure Form Recognizer client library.
- Client authentication: sample_authentication.py
- Recognize receipts: sample_recognize_receipts.py
- Recognize receipts from a URL: sample_recognize_receipts_from_url.py
- Recognize business cards: sample_recognize_business_cards.py
- Recognize invoices: sample_recognize_invoices.py
- Recognize content: sample_recognize_content.py
- Recognize custom forms: sample_recognize_custom_forms.py
- Train a model without labels: sample_train_model_without_labels.py
- Train a model with labels: sample_train_model_with_labels.py
- Manage custom models: sample_manage_custom_models.py
- Copy a model between Form Recognizer resources: sample_copy_model.py
- Create a composed model from a collection of models trained with labels: sample_create_composed_model.py
Async APIs
This library also includes a complete async API supported on Python 3.5+. To use it, you must
first install an async transport, such as aiohttp. Async clients
are found under the azure.ai.formrecognizer.aio namespace.
- Client authentication: sample_authentication_async.py
- Recognize receipts: sample_recognize_receipts_async.py
- Recognize receipts from a URL: sample_recognize_receipts_from_url_async.py
- Recognize business cards: sample_recognize_business_cards_async.py
- Recognize invoices: sample_recognize_invoices_async.py
- Recognize content: sample_recognize_content_async.py
- Recognize custom forms: sample_recognize_custom_forms_async.py
- Train a model without labels: sample_train_model_without_labels_async.py
- Train a model with labels: sample_train_model_with_labels_async.py
- Manage custom models: sample_manage_custom_models_async.py
- Copy a model between Form Recognizer resources: sample_copy_model_async.py
- Create a composed model from a collection of models trained with labels: sample_create_composed_model_async.py
Additional documentation
For more extensive documentation on Azure Cognitive Services Form Recognizer, see the Form Recognizer documentation on docs.microsoft.com.
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Release History
3.1.0b3 (2021-02-09)
Breaking Changes
Appearanceis renamed toTextAppearanceStyleis renamed toTextStyle- Client property
api_versionis no longer exposed. Pass keyword argumentapi_versioninto the client to select the API version
Dependency Updates
- Bumped
sixrequirement from1.6to1.11.0.
3.1.0b2 (2021-01-12)
Bug Fixes
- Package requires azure-core version 1.8.2 or greater
3.1.0b1 (2020-11-23)
This version of the SDK defaults to the latest supported API version, which currently is v2.1-preview.
New features
- New methods
begin_recognize_business_cardsandbegin_recognize_business_cards_from_urlintroduced to the SDK. Use these methods to recognize data from business cards - New methods
begin_recognize_invoicesandbegin_recognize_invoices_from_urlintroduced to the SDK. Use these methods to recognize data from invoices - Recognize receipt methods now take keyword argument
localeto optionally indicate the locale of the receipt for improved results - Added ability to create a composed model from the
FormTrainingClientby calling methodbegin_create_composed_model() - Added support to train and recognize custom forms with selection marks such as check boxes and radio buttons. This functionality is only available for models trained with labels
- Added property
selection_markstoFormPagewhich contains a list ofFormSelectionMark - When passing
include_field_elements=True, the propertyfield_elementsonFieldDataandFormTableCellwill also be populated with any selection marks found on the page - Added the properties
model_nameandpropertiesto typesCustomFormModelandCustomFormModelInfo - Added keyword argument
model_nametobegin_training()andbegin_create_composed_model() - Added model type
CustomFormModelPropertiesthat includes information like if a model is a composed model - Added property
model_idtoCustomFormSubmodelandTrainingDocumentInfo - Added properties
model_idandform_type_confidencetoRecognizedForm appearanceproperty added toFormLineto indicate the style of extracted text - like "handwriting" or "other"- Added keyword argument
pagestobegin_recognize_contentandbegin_recognize_content_from_urlto specify the page numbers to analyze - Added property
bounding_boxtoFormTable - Content-type
image/bmpnow supported by recognize content and prebuilt models - Added keyword argument
languagetobegin_recognize_contentandbegin_recognize_content_from_urlto specify which language to process document in
Dependency updates
- Package now requires azure-common version 1.1
3.0.0 (2020-08-20)
First stable release of the azure-ai-formrecognizer client library.
New features
- Client-level, keyword argument
api_versioncan be used to specify the service API version to use. Currently only v2.0 is supported. See the enumFormRecognizerApiVersionfor supported API versions. FormWordandFormLinenow have attributekindwhich specifies the kind of element it is, e.g. "word" or "line"
3.0.0b1 (2020-08-11)
The version of this package now targets the service's v2.0 API.
Breaking Changes
- Client library version bumped to
3.0.0b1 - Values are now capitalized for enums
FormContentType,LengthUnit,TrainingStatus, andCustomFormModelStatus document_namerenamed tonameonTrainingDocumentInfo- Keyword argument
include_sub_foldersrenamed toinclude_subfoldersonbegin_trainingmethods
New features
FormFieldnow has attributevalue_typewhich contains the semantic data type of the field value. The options forvalue_typeare described in the enumFieldValueType
Fixes and improvements
- Fixes a bug where error code and message weren't being returned on
HttpResponseErrorif operation failed during polling FormFieldpropertyvalue_datais now set toNoneif no values are returned on itsFieldData. Previouslyvalue_datareturned aFieldDatawith all its attributes set toNonein the above case.
1.0.0b4 (2020-07-07)
Breaking Changes
RecognizedReceiptsclass has been removed.begin_recognize_receiptsandbegin_recognize_receipts_from_urlnow returnRecognizedForm.requested_onhas been renamed totraining_started_onandcompleted_onrenamed totraining_completed_ononCustomFormModelandCustomFormModelInfoFieldTexthas been renamed toFieldDataFormContenthas been renamed toFormElement- Parameter
include_text_contenthas been renamed toinclude_field_elementsforbegin_recognize_receipts,begin_recognize_receipts_from_url,begin_recognize_custom_forms, andbegin_recognize_custom_forms_from_url text_contenthas been renamed tofield_elementsonFieldDataandFormTableCell
Fixes and improvements
- Fixes a bug where
text_anglewas being returned out of the specified interval (-180, 180]
1.0.0b3 (2020-06-10)
Breaking Changes
- All asynchronous long running operation methods now return an instance of an
AsyncLROPollerfromazure-core - All asynchronous long running operation methods are renamed with the
begin_prefix to indicate that anAsyncLROPolleris returned:train_modelis renamed tobegin_trainingrecognize_receiptsis renamed tobegin_recognize_receiptsrecognize_receipts_from_urlis renamed tobegin_recognize_receipts_from_urlrecognize_contentis renamed tobegin_recognize_contentrecognize_content_from_urlis renamed tobegin_recognize_content_from_urlrecognize_custom_formsis renamed tobegin_recognize_custom_formsrecognize_custom_forms_from_urlis renamed tobegin_recognize_custom_forms_from_url
- Sync method
begin_train_modelrenamed tobegin_training training_filesparameter ofbegin_trainingis renamed totraining_files_urluse_labelsparameter ofbegin_trainingis renamed touse_training_labelslist_model_infosmethod has been renamed tolist_custom_models- Removed
get_form_training_clientfromFormRecognizerClient - Added
get_form_recognizer_clienttoFormTrainingClient - A
HttpResponseErroris now raised if a model withstatus=="invalid"is returned from thebegin_trainingmethods PageRangeis renamed toFormPageRangefirst_pageandlast_pagerenamed tofirst_page_numberandlast_page_number, respectively onFormPageRangeFormFielddoes not have a page_numberuse_training_labelsis now a required positional param in thebegin_trainingAPIsstreamandurlparameters found on methods forFormRecognizerClienthave been renamed toformandform_url, respectively- For
begin_recognize_receiptmethods, parameters have been renamed toreceiptandreceipt_url created_onandlast_modifiedare renamed torequested_onandcompleted_onin theCustomFormModelandCustomFormModelInfomodelsmodelsproperty ofCustomFormModelis renamed tosubmodelsCustomFormSubModelis renamed toCustomFormSubmodelbegin_recognize_receiptsAPIs now return a list ofRecognizedReceiptinstead ofUSReceipt- Removed
USReceipt. To see how to deal with the return value ofbegin_recognize_receipts, see the recognize receipt samples in the samples directory for details. - Removed
USReceiptItem. To see how to access the individual items on a receipt, see the recognize receipt samples in the samples directory for details. - Removed
USReceiptTypeand thereceipt_typeproperty fromRecognizedReceipt. See the recognize receipt samples in the samples directory for details.
New features
- Support to copy a custom model from one Form Recognizer resource to another
- Authentication using
azure-identitycredentials now supported- see the Azure Identity documentation for more information
page_numberattribute has been added toFormTable- All long running operation methods now accept the keyword argument
continuation_tokento restart the poller from a saved state
Dependency updates
- Adopted azure-core version 1.6.0 or greater
1.0.0b2 (2020-05-06)
Fixes and improvements
- Bug fixed where
confidence==0.0was erroneously getting set to1.0 __repr__has been added to all of the models
1.0.0b1 (2020-04-23)
Version (1.0.0b1) is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Form Recognizer. This library replaces the package found here: https://pypi.org/project/azure-cognitiveservices-formrecognizer/
For more information about this, and preview releases of other Azure SDK libraries, please visit https://azure.github.io/azure-sdk/releases/latest/python.html.
Breaking changes: New API design
- New namespace/package name:
- The namespace/package name for the Form Recognizer client library has changed from
azure.cognitiveservices.formrecognizertoazure.ai.formrecognizer
- The namespace/package name for the Form Recognizer client library has changed from
- Two client design:
- FormRecognizerClient to analyze fields/values on custom forms, receipts, and form content/layout
- FormTrainingClient to train custom models (with/without labels), and manage the custom models on your account
- Different analyze methods based on input type: file stream or URL.
- URL input should use the method with suffix
from_url - Stream methods will automatically detect content-type of the input file
- URL input should use the method with suffix
- Asynchronous APIs added under
azure.ai.formrecognizer.aionamespace - Authentication with API key supported using
AzureKeyCredential("<api_key>")fromazure.core.credentials - New underlying REST pipeline implementation based on the azure-core library
- Client and pipeline configuration is now available via keyword arguments at both the client level, and per-operation. See README for a link to optional configuration arguments
- New error hierarchy:
- All service errors will now use the base type:
azure.core.exceptions.HttpResponseError
- All service errors will now use the base type:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file azure-ai-formrecognizer-3.1.0b3.zip.
File metadata
- Download URL: azure-ai-formrecognizer-3.1.0b3.zip
- Upload date:
- Size: 300.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.1 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2abf23f3497e93387d174e5b7a3cecbb7892f1a93e25aecb6c37642c80f4f567
|
|
| MD5 |
56729e0f665372e925ab19cf7152758b
|
|
| BLAKE2b-256 |
fd600a10a58bc7ac7171bcb82a4959706c6277c32e7bab24a826c64a2270b904
|
File details
Details for the file azure_ai_formrecognizer-3.1.0b3-py2.py3-none-any.whl.
File metadata
- Download URL: azure_ai_formrecognizer-3.1.0b3-py2.py3-none-any.whl
- Upload date:
- Size: 138.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.1 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c60148f9bc5f5ef57ae25647f3901a2b025cff3465047736fae86abde582ba3a
|
|
| MD5 |
1cc23d337f9a47310c83916c8852c0f1
|
|
| BLAKE2b-256 |
045249a4dbbecedb9b5007ab2883c3ed52bd5cf20f79fe223d2f3673d148a68c
|