Class: Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/document_schema.rb

Overview

Defines properties that can be part of the entity type.

Defined Under Namespace

Modules: OccurrenceType

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ ::String

Returns The name of the property. Follows the same guidelines as the EntityType name.

Returns:

  • (::String) —

    The name of the property. Follows the same guidelines as the EntityType name.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_schema.rb', line 177

class Property
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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`.
  module OccurrenceType
    # Unspecified occurrence type.
    OCCURRENCE_TYPE_UNSPECIFIED = 0

    # There will be zero or one instance of this entity type.  The same
    # entity instance may be mentioned multiple times.
    OPTIONAL_ONCE = 1

    # The entity type will appear zero or multiple times.
    OPTIONAL_MULTIPLE = 2

    # The entity type will only appear exactly once.  The same
    # entity instance may be mentioned multiple times.
    REQUIRED_ONCE = 3

    # The entity type will appear once or more times.
    REQUIRED_MULTIPLE = 4
  end
end

#occurrence_type ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType

Returns Occurrence type limits the number of instances an entity type appears in the document.

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_schema.rb', line 177

class Property
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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`.
  module OccurrenceType
    # Unspecified occurrence type.
    OCCURRENCE_TYPE_UNSPECIFIED = 0

    # There will be zero or one instance of this entity type.  The same
    # entity instance may be mentioned multiple times.
    OPTIONAL_ONCE = 1

    # The entity type will appear zero or multiple times.
    OPTIONAL_MULTIPLE = 2

    # The entity type will only appear exactly once.  The same
    # entity instance may be mentioned multiple times.
    REQUIRED_ONCE = 3

    # The entity type will appear once or more times.
    REQUIRED_MULTIPLE = 4
  end
end

#property_metadata ⇒ ::Google::Cloud::DocumentAI::V1beta3::PropertyMetadata

Returns Any additional metadata about the property can be added here.

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_schema.rb', line 177

class Property
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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`.
  module OccurrenceType
    # Unspecified occurrence type.
    OCCURRENCE_TYPE_UNSPECIFIED = 0

    # There will be zero or one instance of this entity type.  The same
    # entity instance may be mentioned multiple times.
    OPTIONAL_ONCE = 1

    # The entity type will appear zero or multiple times.
    OPTIONAL_MULTIPLE = 2

    # The entity type will only appear exactly once.  The same
    # entity instance may be mentioned multiple times.
    REQUIRED_ONCE = 3

    # The entity type will appear once or more times.
    REQUIRED_MULTIPLE = 4
  end
end

#value_type ⇒ ::String

Returns A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

Returns:

  • (::String) —

    A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_schema.rb', line 177

class Property
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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`.
  module OccurrenceType
    # Unspecified occurrence type.
    OCCURRENCE_TYPE_UNSPECIFIED = 0

    # There will be zero or one instance of this entity type.  The same
    # entity instance may be mentioned multiple times.
    OPTIONAL_ONCE = 1

    # The entity type will appear zero or multiple times.
    OPTIONAL_MULTIPLE = 2

    # The entity type will only appear exactly once.  The same
    # entity instance may be mentioned multiple times.
    REQUIRED_ONCE = 3

    # The entity type will appear once or more times.
    REQUIRED_MULTIPLE = 4
  end
end