Reference documentation and code samples for the Document AI V1beta3 API module Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType.
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.
Constants
OCCURRENCE_TYPE_UNSPECIFIED
value: 0 Unspecified occurrence type.
OPTIONAL_ONCE
value: 1 There will be zero or one instance of this entity type. The same
entity instance may be mentioned multiple times.
OPTIONAL_MULTIPLE
value: 2 The entity type will appear zero or multiple times.
REQUIRED_ONCE
value: 3 The entity type will only appear exactly once. The same
entity instance may be mentioned multiple times.
REQUIRED_MULTIPLE
value: 4 The entity type will appear once or more 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-09-04 UTC."],[],[],null,["# Document AI V1beta3 API - Module Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType (v0.43.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.43.1 (latest)](/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.43.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.43.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.42.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.42.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.41.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.41.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.40.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.40.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.39.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.39.1/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.38.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.38.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.37.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.37.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.36.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.36.1/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.35.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.35.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.34.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.34.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.33.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.33.1/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.32.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.32.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.31.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.31.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.30.2](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.30.2/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.29.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.29.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.28.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.28.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.27.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.27.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.26.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.26.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.25.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.25.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.24.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.24.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.23.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.23.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.22.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.22.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.21.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.21.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.20.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.20.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.19.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.19.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.18.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.18.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.17.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.17.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.16.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.16.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.15.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.15.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.14.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.14.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.13.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.13.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.12.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.12.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.11.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.11.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.10.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.10.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType)\n- [0.9.4](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.9.4/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-EntityType-Property-OccurrenceType) \nReference documentation and code samples for the Document AI V1beta3 API module Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType.\n\nTypes of occurrences of the entity type in the document. This\nrepresents the number of instances, not mentions, of an entity.\nFor example, a bank statement might only have one\n`account_number`, but this account number can be mentioned in several\nplaces on the document. In this case, the `account_number` is\nconsidered a `REQUIRED_ONCE` entity type. If, on the other hand, we\nexpect a bank statement to contain the status of multiple different\naccounts for the customers, the occurrence type is set to\n`REQUIRED_MULTIPLE`.\n\nConstants\n---------\n\n### OCCURRENCE_TYPE_UNSPECIFIED\n\n**value:** 0 \nUnspecified occurrence type.\n\n### OPTIONAL_ONCE\n\n**value:** 1 \nThere will be zero or one instance of this entity type. The same\nentity instance may be mentioned multiple times.\n\n### OPTIONAL_MULTIPLE\n\n**value:** 2 \nThe entity type will appear zero or multiple times.\n\n### REQUIRED_ONCE\n\n**value:** 3 \nThe entity type will only appear exactly once. The same\nentity instance may be mentioned multiple times.\n\n### REQUIRED_MULTIPLE\n\n**value:** 4 \nThe entity type will appear once or more times."]]