Learn how to configure document processors through our API
schema
)object
typestring
, number
, integer
, boolean
, object
, and array
string
, number
, boolean
, integer
) must be nullable (use array type with “null” as an option e.g. "type": ["string", "null"]
)null
option"extend:type": "currency"
, "extend:type": "signature"
, or "extend:type": "date"
property to the appropriate field type with the required properties. See below for examples."extend:name"
property. If supplied, this will override the name of the property as it will appear to the model, but not in the output returned to you. This is useful for providing more descriptive names or instructions to the model without altering the actual keys in your output data structure."extend:descriptions"
property.anyOf
, oneOf
, allOf
, schema definitions, or recursive schemasextend:descriptions
is an optional array of strings. It is recommended to give more context for each enum option for more accurate extraction.
extend:type
keyword enables custom pre-processing and post-processing of fields which bake in best practices and heuristics for the field type.
extend:type
keyword with the value date
. This will guarantee the date format is always an ISO compliant date (yyyy-mm-dd).
Basic Example
Example with nested fields
Example with nested arrays and objects
Example with signature, currency, and date fields
JSON Schema Type Definitions
fields
)Basic Example
Example with Nested Fields
Example with nested arrays and objects