Class: OCI::GenerativeAiAgent::Models::PersonallyIdentifiableInformationGuardrailConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb

Overview

The configuration details for Personally Identifiable Information.

Constant Summary collapse

INPUT_GUARDRAIL_MODE_ENUM = 
[
  INPUT_GUARDRAIL_MODE_DISABLE = 'DISABLE'.freeze,
  INPUT_GUARDRAIL_MODE_BLOCK = 'BLOCK'.freeze,
  INPUT_GUARDRAIL_MODE_INFORM = 'INFORM'.freeze,
  INPUT_GUARDRAIL_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OUTPUT_GUARDRAIL_MODE_ENUM = 
[
  OUTPUT_GUARDRAIL_MODE_DISABLE = 'DISABLE'.freeze,
  OUTPUT_GUARDRAIL_MODE_BLOCK = 'BLOCK'.freeze,
  OUTPUT_GUARDRAIL_MODE_INFORM = 'INFORM'.freeze,
  OUTPUT_GUARDRAIL_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PersonallyIdentifiableInformationGuardrailConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 62

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

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

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

  self.output_guardrail_mode = attributes[:'outputGuardrailMode'] if attributes[:'outputGuardrailMode']

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

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

Instance Attribute Details

#input_guardrail_mode ⇒ String

An input guardrail mode for personally identifiable information.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 28

def input_guardrail_mode
  @input_guardrail_mode
end

#output_guardrail_mode ⇒ String

An output guardrail mode for personally identifiable information.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 32

def output_guardrail_mode
  @output_guardrail_mode
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
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'input_guardrail_mode': :'inputGuardrailMode',
    'output_guardrail_mode': :'outputGuardrailMode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'input_guardrail_mode': :'String',
    'output_guardrail_mode': :'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



114
115
116
117
118
119
120
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 114

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

  self.class == other.class &&
    input_guardrail_mode == other.input_guardrail_mode &&
    output_guardrail_mode == other.output_guardrail_mode
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



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

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


125
126
127
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 134

def hash
  [input_guardrail_mode, output_guardrail_mode].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 178

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



172
173
174
 
# File 'lib/oci/generative_ai_agent/models/personally_identifiable_information_guardrail_config.rb', line 172

def to_s
  to_hash.to_s
end