What's new in Form Recognizer?

This article highlights the major changes that come with new versions of the Form Recognizer API.

Note

The quickstarts and guides in this doc set always use the latest version of the API, unless they specify otherwise.

Form Recognizer 2.0 (preview)

New features

  • Custom model

    • Train with labels You can now train a custom model with manually labeled data. This results in better-performing models and can produce models that work with complex forms or forms containing values without keys.
    • Asynchronous API You can use async API calls to train with and analyze large data sets and files.
    • TIFF file support You can now train with and extract data from TIFF documents.
    • Extraction accuracy improvements
  • Prebuilt receipt model

    • Tip amounts You can now extract tip amounts and other handwritten values.
    • Line item extraction You can extract line item values from receipts.
    • Confidence values You can view the model's confidence for each extracted value.
    • Extraction accuracy improvements
  • Layout extraction You can now use the Layout API to extract text data and table data from your forms.

Custom model API changes

All of the APIs for training and using custom models have been renamed, and some synchronous methods are now asynchronous. The following are major changes:

  • The process of training a model is now asynchronous. You initiate training through the /custom/models API call. This call returns an operation ID, which you can pass into custom/models/{modelID} to return the training results.
  • Key/value extraction is now initiated by the /custom/models/{modelID}/analyze API call. This call returns an operation ID, which you can pass into custom/models/{modelID}/analyzeResults/{resultID} to return the extraction results.
  • Operation IDs for the Train operation are now found in the Location header of HTTP responses, not the Operation-Location header.

Receipt API changes

The APIs for reading sales receipts have been renamed.

  • Receipt data extraction is now initiated by the /prebuilt/receipt/analyze API call. This call returns an operation ID, which you can pass into /prebuilt/receipt/analyzeResults/{resultID} to return the extraction results.

Output format changes

The JSON responses for all API calls have new formats. Some keys and values have been added, removed, or renamed. See the quickstarts for examples of the current JSON formats.

Next steps

Complete a quickstart to get started with the Form Recognizer APIs.