Class Property (2.29.1)

Property(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines properties that can be part of the entity type.


Name Description
name str
The name of the property. Follows the same guidelines as the EntityType name.
display_name str
User defined name for the property.
value_type str
A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.
Occurrence type limits the number of instances an entity type appears in the document.




Types of occurrences of the entity type in the document. This represents the number of instances, not mentions, of an entity. For example, a bank statement might only have one account_number, but this account number can be mentioned in several places on the document. In this case, the account_number is considered a REQUIRED_ONCE entity type. If, on the other hand, we expect a bank statement to contain the status of multiple different accounts for the customers, the occurrence type is set to REQUIRED_MULTIPLE.