Skip to main content
DocumentDefinition contains an object of type RootConcept.

​
DocumentDefinition

PropertyTypeDescription
RootConceptConceptThe root concept of the extracted information.
Extracted elements are represented by concepts. Each concept corresponds to one type of object and has a unique name, ID, and fields description.

​
Concept

PropertyTypeDescription
IdStringThe ID of the concept.
NameStringThe name of the concept.
FieldsConceptField []A description of the structure of the extracted fields.
ConceptField describes the structure of the extracted fields. A field may contain values of different types, either simple (e.g. string, data, number, bool, or image) or combined (i.e. a child object).

​
ConceptField

PropertyTypeDescription
IdStringThe ID of the field.
NameStringThe name of the field.
TypeEnum {Concept / String / Image / ISOdate / Boolean / Decimal / Enum}The type of field data.
EnumValuesEnumValue []The enumeration of the possible field values. Note: This property is not implemented.
CardinalityCardinalityWhether the field recurs multiple time in the document.
ValueConceptsConcept []A description of the child concepts.
ValueConceptIdsString []An array of the IDs of the child concepts. This property becomes available only if one concept is a child of multiple parent concepts. The child concept will be written in its entirety in the ValueConcepts property of one of its parent concepts. The other parent concepts will only get its identifier in their ValueConceptIds property.
EnumValue describes the Enum element of the ConceptField object.

​
EnumValue

PropertyTypeDescription
IdStringThe ID of the element.
NameStringThe name of the element.
Note: The EnumValues property is not implemented. Cardinality specifies whether the field recurs multiple times in the document.

​
Cardinality

PropertyTypeDescription
MinIntegerThe minimum number of instances.
MaxIntegerThe maximum number of instances.
If Min=0 and Max=1, the field must not recur in the document. If Min=0 and Max= -1, the field may recur multiple times in the document.