Class: OCI::AiLanguage::Models::BatchDetectLanguagePiiEntitiesDetails

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

Overview

The documents details to detect personal identification information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchDetectLanguagePiiEntitiesDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 74

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._alias = attributes[:'alias'] if attributes[:'alias']

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

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

  self.endpoint_id = attributes[:'endpointId'] if attributes[:'endpointId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

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

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

Instance Attribute Details

#_alias ⇒ String

Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

Returns:

  • (String) 


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

def _alias
  @_alias
end

#compartment_id ⇒ String

The OCID of the compartment that calls the API, inference will be served from pre trained model

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#documents ⇒ Array<OCI::AiLanguage::Models::TextDocument>

[Required] List of documents to detect personal identification information.

Returns:



25
26
27
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 25

def documents
  @documents
end

#endpoint_id ⇒ String

The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.

Returns:

  • (String) 


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

def endpoint_id
  @endpoint_id
end

#masking ⇒ Hash<String, OCI::AiLanguage::Models::PiiEntityMasking>

Mask recognized PII entities with different modes.

Returns:



29
30
31
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 29

def masking
  @masking
end

#profile ⇒ OCI::AiLanguage::Models::Profile

Returns:



32
33
34
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 32

def profile
  @profile
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'alias',
    'endpoint_id': :'endpointId',
    'compartment_id': :'compartmentId',
    'documents': :'documents',
    'masking': :'masking',
    'profile': :'profile'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'String',
    'endpoint_id': :'String',
    'compartment_id': :'String',
    'documents': :'Array<OCI::AiLanguage::Models::TextDocument>',
    'masking': :'Hash<String, OCI::AiLanguage::Models::PiiEntityMasking>',
    'profile': :'OCI::AiLanguage::Models::Profile'
    # 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



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 112

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

  self.class == other.class &&
    _alias == other._alias &&
    endpoint_id == other.endpoint_id &&
    compartment_id == other.compartment_id &&
    documents == other.documents &&
    masking == other.masking &&
    profile == other.profile
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



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

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


127
128
129
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 127

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



136
137
138
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 136

def hash
  [_alias, endpoint_id, compartment_id, documents, masking, profile].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 180

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



174
175
176
 
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 174

def to_s
  to_hash.to_s
end