Class: OCI::GenerativeAiInference::Models::GuardrailConfigs

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/guardrail_configs.rb

Overview

Additional configuration for each guardrail.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GuardrailConfigs

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 51

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

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

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

  self.personally_identifiable_information_config = attributes[:'personallyIdentifiableInformationConfig'] if attributes[:'personallyIdentifiableInformationConfig']

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

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

  self.prompt_injection_config = attributes[:'promptInjectionConfig'] if attributes[:'promptInjectionConfig']

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

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

Instance Attribute Details

#content_moderation_config ⇒ OCI::GenerativeAiInference::Models::ContentModerationConfiguration

Returns:



12
13
14
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 12

def content_moderation_config
  @content_moderation_config
end

#personally_identifiable_information_config ⇒ OCI::GenerativeAiInference::Models::PersonallyIdentifiableInformationConfiguration

Returns:



15
16
17
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 15

def personally_identifiable_information_config
  @personally_identifiable_information_config
end

#prompt_injection_config ⇒ OCI::GenerativeAiInference::Models::PromptInjectionConfiguration

Returns:



18
19
20
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 18

def prompt_injection_config
  @prompt_injection_config
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
29
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'content_moderation_config': :'contentModerationConfig',
    'personally_identifiable_information_config': :'personallyIdentifiableInformationConfig',
    'prompt_injection_config': :'promptInjectionConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 32

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'content_moderation_config': :'OCI::GenerativeAiInference::Models::ContentModerationConfiguration',
    'personally_identifiable_information_config': :'OCI::GenerativeAiInference::Models::PersonallyIdentifiableInformationConfiguration',
    'prompt_injection_config': :'OCI::GenerativeAiInference::Models::PromptInjectionConfiguration'
    # 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



83
84
85
86
87
88
89
90
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 83

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

  self.class == other.class &&
    content_moderation_config == other.content_moderation_config &&
    personally_identifiable_information_config == other.personally_identifiable_information_config &&
    prompt_injection_config == other.prompt_injection_config
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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 115

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


95
96
97
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 95

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



104
105
106
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 104

def hash
  [content_moderation_config, personally_identifiable_information_config, prompt_injection_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 148

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



142
143
144
 
# File 'lib/oci/generative_ai_inference/models/guardrail_configs.rb', line 142

def to_s
  to_hash.to_s
end