Edit

Custom template document model

  • Article
  • 2 minutes to read

This article applies to: Form Recognizer v3.0 checkmark Form Recognizer v3.0. Earlier version: Form Recognizer v2.1

This article applies to: Form Recognizer v2.1 checkmark Form Recognizer v2.1. Later version: Form Recognizer v3.0

Custom template (formerly custom form) is an easy-to-train document model that accurately extracts labeled key-value pairs, selection marks, tables, regions, and signatures from documents. Template models use layout cues to extract values from documents and are suitable to extract fields from highly structured documents with defined visual templates.

Custom template models share the same labeling format and strategy as custom neural models, with support for more field types and languages.

Model capabilities

Custom template models support key-value pairs, selection marks, tables, signature fields, and selected regions.

Form fields Selection marks Tabular fields (Tables) Signature Selected regions
Supported Supported Supported Supported Supported

Tabular fields

With the release of API versions 2022-06-30-preview and later, custom template models will add support for cross page tabular fields (tables):

  • To label a table that spans multiple pages, label each row of the table across the different pages in a single table.
  • As a best practice, ensure that your dataset contains a few samples of the expected variations. For example, include samples where the entire table is on a single page and where tables span two or more pages if you expect to see those variations in documents.

Tabular fields are also useful when extracting repeating information within a document that isn't recognized as a table. For example, a repeating section of work experiences in a resume can be labeled and extracted as a tabular field.

Dealing with variations

Template models rely on a defined visual template, changes to the template will result in lower accuracy. In those instances, split your training dataset to include at least five samples of each template and train a model for each of the variations. You can then compose the models into a single endpoint. For subtle variations, like digital PDF documents and images, it's best to include at least five examples of each type in the same training dataset.

Training a model

Custom template models are generally available with the v3.0 API. If you're starting with a new project or have an existing labeled dataset, use the v3 API with Form Recognizer Studio to train a custom template model.

Model REST API SDK Label and Test Models
Custom template Form Recognizer 3.0 Form Recognizer SDK Form Recognizer Studio

With the v3.0 API, the build operation to train model supports a new buildMode property, to train a custom template model, set the buildMode to template.

https://{endpoint}/formrecognizer/documentModels:build?api-version=2022-08-31

{
  "modelId": "string",
  "description": "string",
  "buildMode": "template",
  "azureBlobSource":
  {
    "containerUrl": "string",
    "prefix": "string"
  }
}

Custom (template) models are generally available with the v2.1 API.

Model REST API SDK Label and Test Models
Custom model (template) Form Recognizer 2.1 Form Recognizer SDK Form Recognizer Sample labeling tool

Next steps

Learn to create and compose custom models: