Class: OCI::AiLanguage::Models::PiiEntityDocumentResult

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/pii_entity_document_result.rb

Overview

The document response for batch detect personal identification.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PiiEntityDocumentResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 86

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

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

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

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

  self.masked_text = attributes[:'maskedText'] if attributes[:'maskedText']

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

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

  self.language_code = attributes[:'languageCode'] if attributes[:'languageCode']

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

  self.language_code = attributes[:'language_code'] if attributes[:'language_code']
end

Instance Attribute Details

#entities ⇒ Array<OCI::AiLanguage::Models::PiiEntity>

[Required] List of batch detect personal identification.

Returns:



17
18
19
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 17

def entities
  @entities
end

#key ⇒ String

[Required] Document unique identifier defined by the user.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 13

def key
  @key
end

#language_code ⇒ String

[Required] Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 50

def language_code
  @language_code
end

#masked_text ⇒ String

[Required] Masked text per given mask mode.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 21

def masked_text
  @masked_text
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'entities': :'entities',
    'masked_text': :'maskedText',
    'language_code': :'languageCode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'entities': :'Array<OCI::AiLanguage::Models::PiiEntity>',
    'masked_text': :'String',
    'language_code': :'String'
    # 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



116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 116

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

  self.class == other.class &&
    key == other.key &&
    entities == other.entities &&
    masked_text == other.masked_text &&
    language_code == other.language_code
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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 149

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


129
130
131
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 129

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



138
139
140
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 138

def hash
  [key, entities, masked_text, language_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 182

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



176
177
178
 
# File 'lib/oci/ai_language/models/pii_entity_document_result.rb', line 176

def to_s
  to_hash.to_s
end