Class: Mindee::V1::Parsing::Standard::StringField

Inherits:

BaseField

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

Defined in:

lib/mindee/v1/parsing/standard/string_field.rb

Overview

Represents basic text information.

Direct Known Subclasses

AddressField

Instance Attribute Summary

• #raw_value ⇒ String^? readonly

  Value as String.

• #value ⇒ String^? readonly

  Value as String.

Attributes inherited from BaseField

#reconstructed

Attributes inherited from AbstractField

#bounding_box, #confidence, #page_id, #polygon

Instance Method Summary

• #initialize(prediction, page_id = nil, reconstructed: false) ⇒ StringField constructor

  A new instance of StringField.

Methods inherited from AbstractField

array_confidence, array_sum, float_to_string, #to_s

Constructor Details

#initialize(prediction, page_id = nil, reconstructed: false) ⇒ StringField

Returns a new instance of StringField.

# File 'lib/mindee/v1/parsing/standard/string_field.rb', line 18

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

Instance Attribute Details

#raw_value ⇒ String^? (readonly)

Value as String

Returns:

• (String, nil)

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

def raw_value
  @raw_value
end

#value ⇒ String^? (readonly)

Value as String

Returns:

• (String, nil)

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

def value
  @value
end