Fields describe properties of the document itself. Fields are often used to get metadata such as the perceived language or the type of document from a list of possible types.
Parameter | Type | Description |
|---|---|---|
field_id | string | Unique identifier. |
title (optional) | string | Display title. It can be formatted as a short label or a longer question or sentence. |
required (optional) | boolean | If the field is required there will always be a corresponding value in the response. |
per_page (optional) | boolean | If the field is defined for each page, or for the entire document |
type | string | The specified |
options (conditional) | object array | Only for |
Field vs Feature: What is the difference?
Every feature represents a class of content in the document that can be annotated with a location in the pages of the document. Every field represents a question about the document as a whole.
Params Field Params Object Type Response Field Response Object Type featuresFeature annotationsDocument Transcription Annotation fieldsField valuesDocument Transcription Value