Class: OCI::GenerativeAi::Models::ContentModerationConfig

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

Overview

The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses.

Constant Summary collapse

MODE_ENUM = 
[
  MODE_INFORM = 'INFORM'.freeze,
  MODE_BLOCK = 'BLOCK'.freeze,
  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 = {}) ⇒ ContentModerationConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :mode (String) —

    The value to assign to the #mode property

  • :model_id (String) —

    The value to assign to the #model_id property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property



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

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

  self.model_id = attributes[:'modelId'] if attributes[:'modelId']

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
end

Instance Attribute Details

#is_enabled ⇒ BOOLEAN

[Required] Whether to enable the content moderation feature.

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 28

def is_enabled
  @is_enabled
end

#mode ⇒ String

Enum for the modes of operation for inference protection.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 20

def mode
  @mode
end

#model_id ⇒ String

The OCID of the model used for the feature.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 24

def model_id
  @model_id
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
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'mode': :'mode',
    'model_id': :'modelId',
    'is_enabled': :'isEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 42

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



103
104
105
106
107
108
109
110
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 103

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

  self.class == other.class &&
    mode == other.mode &&
    model_id == other.model_id &&
    is_enabled == other.is_enabled
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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 135

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


115
116
117
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 124

def hash
  [mode, model_id, is_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 168

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



162
163
164
 
# File 'lib/oci/generative_ai/models/content_moderation_config.rb', line 162

def to_s
  to_hash.to_s
end