Class: OCI::AiDocument::Models::DocumentTextExtractionFeature

Inherits:
DocumentFeature
  • Object
show all
Defined in:
lib/oci/ai_document/models/document_text_extraction_feature.rb

Overview

Text recognition

Constant Summary

Constants inherited from DocumentFeature

OCI::AiDocument::Models::DocumentFeature::FEATURE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DocumentFeature

#feature_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DocumentFeature

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DocumentTextExtractionFeature

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 57

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['featureType'] = 'TEXT_EXTRACTION'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.generate_searchable_pdf = attributes[:'generateSearchablePdf'] unless attributes[:'generateSearchablePdf'].nil?
  self.generate_searchable_pdf = false if generate_searchable_pdf.nil? && !attributes.key?(:'generateSearchablePdf') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :generateSearchablePdf and :generate_searchable_pdf' if attributes.key?(:'generateSearchablePdf') && attributes.key?(:'generate_searchable_pdf')

  self.generate_searchable_pdf = attributes[:'generate_searchable_pdf'] unless attributes[:'generate_searchable_pdf'].nil?
  self.generate_searchable_pdf = false if generate_searchable_pdf.nil? && !attributes.key?(:'generateSearchablePdf') && !attributes.key?(:'generate_searchable_pdf') # rubocop:disable Style/StringLiterals

  self.model_id = attributes[:'modelId'] if attributes[:'modelId']

  raise 'You cannot provide both :modelId and :model_id' if attributes.key?(:'modelId') && attributes.key?(:'model_id')

  self.model_id = attributes[:'model_id'] if attributes[:'model_id']

  self.selection_mark_detection = attributes[:'selectionMarkDetection'] unless attributes[:'selectionMarkDetection'].nil?
  self.selection_mark_detection = false if selection_mark_detection.nil? && !attributes.key?(:'selectionMarkDetection') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :selectionMarkDetection and :selection_mark_detection' if attributes.key?(:'selectionMarkDetection') && attributes.key?(:'selection_mark_detection')

  self.selection_mark_detection = attributes[:'selection_mark_detection'] unless attributes[:'selection_mark_detection'].nil?
  self.selection_mark_detection = false if selection_mark_detection.nil? && !attributes.key?(:'selectionMarkDetection') && !attributes.key?(:'selection_mark_detection') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#generate_searchable_pdf ⇒ BOOLEAN

Whether or not to generate a searchable PDF file.

Returns:

  • (BOOLEAN) 


14
15
16
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 14

def generate_searchable_pdf
  @generate_searchable_pdf
end

#model_id ⇒ String

Unique identifier custom model OCID that should be used for inference.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 18

def model_id
  @model_id
end

#selection_mark_detection ⇒ BOOLEAN

Whether checkbox detection feature is enabled or disabled.

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 22

def selection_mark_detection
  @selection_mark_detection
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'feature_type': :'featureType',
    'generate_searchable_pdf': :'generateSearchablePdf',
    'model_id': :'modelId',
    'selection_mark_detection': :'selectionMarkDetection'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'feature_type': :'String',
    'generate_searchable_pdf': :'BOOLEAN',
    'model_id': :'String',
    'selection_mark_detection': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 97

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    feature_type == other.feature_type &&
    generate_searchable_pdf == other.generate_searchable_pdf &&
    model_id == other.model_id &&
    selection_mark_detection == other.selection_mark_detection
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 130

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


110
111
112
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 110

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 119

def hash
  [feature_type, generate_searchable_pdf, model_id, selection_mark_detection].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 163

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



157
158
159
 
# File 'lib/oci/ai_document/models/document_text_extraction_feature.rb', line 157

def to_s
  to_hash.to_s
end