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.
Enums
Name
Description
OCCURRENCE_TYPE_UNSPECIFIED
Unspecified occurrence type.
OPTIONAL_ONCE
There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.
OPTIONAL_MULTIPLE
The entity type will appear zero or multiple times.
REQUIRED_ONCE
The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class OccurrenceType (3.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.5.0 (latest)](/python/docs/reference/documentai/latest/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [3.4.0](/python/docs/reference/documentai/3.4.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [3.3.0](/python/docs/reference/documentai/3.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [3.2.0](/python/docs/reference/documentai/3.2.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [3.1.0](/python/docs/reference/documentai/3.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [3.0.1](/python/docs/reference/documentai/3.0.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.35.0](/python/docs/reference/documentai/2.35.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.34.0](/python/docs/reference/documentai/2.34.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.33.0](/python/docs/reference/documentai/2.33.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.32.0](/python/docs/reference/documentai/2.32.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.30.0](/python/docs/reference/documentai/2.30.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.29.3](/python/docs/reference/documentai/2.29.3/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.28.0](/python/docs/reference/documentai/2.28.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.27.1](/python/docs/reference/documentai/2.27.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.26.0](/python/docs/reference/documentai/2.26.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.25.0](/python/docs/reference/documentai/2.25.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.24.2](/python/docs/reference/documentai/2.24.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.23.0](/python/docs/reference/documentai/2.23.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.22.0](/python/docs/reference/documentai/2.22.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.21.1](/python/docs/reference/documentai/2.21.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.20.2](/python/docs/reference/documentai/2.20.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.19.0](/python/docs/reference/documentai/2.19.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.18.0](/python/docs/reference/documentai/2.18.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.17.0](/python/docs/reference/documentai/2.17.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.16.1](/python/docs/reference/documentai/2.16.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.15.0](/python/docs/reference/documentai/2.15.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.14.0](/python/docs/reference/documentai/2.14.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.13.0](/python/docs/reference/documentai/2.13.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.12.0](/python/docs/reference/documentai/2.12.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.11.0](/python/docs/reference/documentai/2.11.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.10.0](/python/docs/reference/documentai/2.10.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.9.1](/python/docs/reference/documentai/2.9.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.8.0](/python/docs/reference/documentai/2.8.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.7.0](/python/docs/reference/documentai/2.7.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.6.0](/python/docs/reference/documentai/2.6.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.5.0](/python/docs/reference/documentai/2.5.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.4.1](/python/docs/reference/documentai/2.4.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.3.0](/python/docs/reference/documentai/2.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.2.0](/python/docs/reference/documentai/2.2.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.1.0](/python/docs/reference/documentai/2.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [2.0.3](/python/docs/reference/documentai/2.0.3/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [1.5.1](/python/docs/reference/documentai/1.5.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [1.4.2](/python/docs/reference/documentai/1.4.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [1.3.0](/python/docs/reference/documentai/1.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [1.2.1](/python/docs/reference/documentai/1.2.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [1.1.0](/python/docs/reference/documentai/1.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [1.0.0](/python/docs/reference/documentai/1.0.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [0.5.2](/python/docs/reference/documentai/0.5.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [0.4.0](/python/docs/reference/documentai/0.4.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [0.3.0](/python/docs/reference/documentai/0.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [0.2.0](/python/docs/reference/documentai/0.2.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType)\n- [0.1.0](/python/docs/reference/documentai/0.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property.OccurrenceType) \n\n OccurrenceType(value)\n\nTypes of occurrences of the entity type in the document. This\nrepresents the number of instances, not mentions, of an entity. For\nexample, a bank statement might only have one `account_number`,\nbut this account number can be mentioned in several places on the\ndocument. In this case, the `account_number` is considered a\n`REQUIRED_ONCE` entity type. If, on the other hand, we expect a\nbank statement to contain the status of multiple different accounts\nfor the customers, the occurrence type is set to\n`REQUIRED_MULTIPLE`."]]