Class: Mindee::V1::Parsing::Standard::BaseField

Inherits:

AbstractField

• Object
• AbstractField
• Mindee::V1::Parsing::Standard::BaseField

Defined in:

lib/mindee/v1/parsing/standard/base_field.rb,
sig/mindee/v1/parsing/standard/base_field.rbs

Overview

Base field object.

Direct Known Subclasses

AmountField, BooleanField, ClassificationField, CompanyRegistrationField, DateField, FeatureField, PaymentDetailsField, StringField, TaxField

Instance Attribute Summary

• #reconstructed ⇒ bool readonly

  true if the field was reconstructed or computed using other fields.

• #value ⇒ String, ... readonly

Attributes inherited from AbstractField

#bounding_box, #confidence, #page_id, #polygon

Instance Method Summary

• #initialize(prediction, page_id, reconstructed: false) ⇒ BaseField constructor

  A new instance of BaseField.

Methods inherited from AbstractField

array_confidence, array_sum, float_to_string, #to_s

Constructor Details

#initialize(prediction, page_id, reconstructed: false) ⇒ BaseField

Returns a new instance of BaseField.

Parameters:

• (defaults to: false)
• (defaults to: false)

# File 'lib/mindee/v1/parsing/standard/base_field.rb', line 21

def initialize(prediction, page_id, reconstructed: false)
  super(prediction, page_id)
  @value = prediction['value']
  @reconstructed = reconstructed
end

Instance Attribute Details

#reconstructed ⇒ bool (readonly)

true if the field was reconstructed or computed using other fields.

Returns:

# File 'lib/mindee/v1/parsing/standard/base_field.rb', line 16

def reconstructed
  @reconstructed
end

#value ⇒ String, ... (readonly)

Returns:

# File 'lib/mindee/v1/parsing/standard/base_field.rb', line 13

def value
  @value
end