Class: OCI::AiLanguage::Models::BatchDetectLanguagePiiEntitiesDetails
- Inherits:
-
Object
- Object
- OCI::AiLanguage::Models::BatchDetectLanguagePiiEntitiesDetails
- 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
-
#compartment_id ⇒ String
The OCID of the compartment that calls the API, inference will be served from pre trained model.
-
#documents ⇒ Array<OCI::AiLanguage::Models::TextDocument>
[Required] List of documents to detect personal identification information.
-
#endpoint_id ⇒ String
The endpoint which have to be used for inferencing.
-
#masking ⇒ Hash<String, OCI::AiLanguage::Models::PiiEntityMasking>
Mask recognized PII entities with different modes.
- #profile ⇒ OCI::AiLanguage::Models::Profile
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BatchDetectLanguagePiiEntitiesDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ BatchDetectLanguagePiiEntitiesDetails
Initializes the object
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 67 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.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
#compartment_id ⇒ String
The OCID of the compartment that calls the API, inference will be served from pre trained model
17 18 19 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 17 def compartment_id @compartment_id end |
#documents ⇒ Array<OCI::AiLanguage::Models::TextDocument>
[Required] List of documents to detect personal identification information.
21 22 23 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 21 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.
13 14 15 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 13 def endpoint_id @endpoint_id end |
#masking ⇒ Hash<String, OCI::AiLanguage::Models::PiiEntityMasking>
Mask recognized PII entities with different modes.
25 26 27 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 25 def masking @masking end |
#profile ⇒ OCI::AiLanguage::Models::Profile
28 29 30 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 28 def profile @profile end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 31 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'endpoint_id': :'endpointId', 'compartment_id': :'compartmentId', 'documents': :'documents', 'masking': :'masking', 'profile': :'profile' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 44 def self.swagger_types { # rubocop:disable Style/SymbolLiteral '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.
99 100 101 102 103 104 105 106 107 108 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 99 def ==(other) return true if equal?(other) self.class == other.class && 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
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 133 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
113 114 115 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 113 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
122 123 124 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 122 def hash [endpoint_id, compartment_id, documents, masking, profile].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
166 167 168 169 170 171 172 173 174 175 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 166 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
160 161 162 |
# File 'lib/oci/ai_language/models/batch_detect_language_pii_entities_details.rb', line 160 def to_s to_hash.to_s end |