Reference documentation and code samples for the Google Cloud Document Ai V1 Client class OccurrenceType.
Types of occurrences of the entity type in the document. This
represents the number of instances of instances of an entity, not
number of mentions of an entity. For example, a bank statement may
only have one account_number
, but this account number may be
mentioned in several places on the document. In this case the
'account_number' would be 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 will
be set to REQUIRED_MULTIPLE
.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType.Property.OccurrenceType
Namespace
Google \ Cloud \ DocumentAI \ V1 \ DocumentSchema \ EntityType \ PropertyMethods
static::name
Parameter | |
---|---|
Name | Description |
value |
mixed
|
static::value
Parameter | |
---|---|
Name | Description |
name |
mixed
|
Constants
OCCURRENCE_TYPE_UNSPECIFIED
Value: 0
Unspecified occurrence type.
Generated from protobuf enum OCCURRENCE_TYPE_UNSPECIFIED = 0;
OPTIONAL_ONCE
Value: 1
There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.
Generated from protobuf enum OPTIONAL_ONCE = 1;
OPTIONAL_MULTIPLE
Value: 2
The entity type will appear zero or multiple times.
Generated from protobuf enum OPTIONAL_MULTIPLE = 2;
REQUIRED_ONCE
Value: 3
The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.
Generated from protobuf enum REQUIRED_ONCE = 3;
REQUIRED_MULTIPLE
Value: 4
The entity type will appear once or more times.
Generated from protobuf enum REQUIRED_MULTIPLE = 4;