Class: OCI::GenerativeAiAgent::Models::ContentModerationConfig

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

Overview

The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContentModerationConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 48

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.should_enable_on_input = attributes[:'shouldEnableOnInput'] unless attributes[:'shouldEnableOnInput'].nil?
  self.should_enable_on_input = false if should_enable_on_input.nil? && !attributes.key?(:'shouldEnableOnInput') # rubocop:disable Style/StringLiterals

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

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

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

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

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

Instance Attribute Details

#should_enable_on_input ⇒ BOOLEAN

A flag to enable or disable content moderation on input.

Returns:

  • (BOOLEAN) 


14
15
16
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 14

def should_enable_on_input
  @should_enable_on_input
end

#should_enable_on_output ⇒ BOOLEAN

A flag to enable or disable content moderation on output.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 18

def should_enable_on_output
  @should_enable_on_output
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'should_enable_on_input': :'shouldEnableOnInput',
    'should_enable_on_output': :'shouldEnableOnOutput'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
37
38
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 31

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'should_enable_on_input': :'BOOLEAN',
    'should_enable_on_output': :'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



78
79
80
81
82
83
84
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 78

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

  self.class == other.class &&
    should_enable_on_input == other.should_enable_on_input &&
    should_enable_on_output == other.should_enable_on_output
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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 109

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


89
90
91
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 89

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



98
99
100
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 98

def hash
  [should_enable_on_input, should_enable_on_output].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 142

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



136
137
138
 
# File 'lib/oci/generative_ai_agent/models/content_moderation_config.rb', line 136

def to_s
  to_hash.to_s
end