openapi_openai 1.0.0 → 1.2.0

data/lib/openapi_openai/models/create_moderation_response_results_inner_categories.rb

@@ -1,12 +1,12 @@
 =begin
 #OpenAI API
 
-#APIs for sampling from and fine-tuning language models
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 
-The version of the OpenAPI document: 2.0.0
+The version of the OpenAPI document: 2.3.0
 Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.4.0
+Generator version: 7.18.0
 
 =end
 
@@ -14,19 +14,45 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  class CreateModerationResponseResultsInnerCategories
+  # A list of the categories, and whether they are flagged or not.
+  class CreateModerationResponseResultsInnerCategories < ApiModelBase
+    # Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Hateful content aimed at non-protected groups (e.g., chess players) is harassment.
     attr_accessor :hate
 
+    # Hateful content that also includes violence or serious harm towards the targeted group based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste.
     attr_accessor :hate_threatening
 
+    # Content that expresses, incites, or promotes harassing language towards any target.
+    attr_accessor :harassment
+
+    # Harassment content that also includes violence or serious harm towards any target.
+    attr_accessor :harassment_threatening
+
+    # Content that includes instructions or advice that facilitate the planning or execution of wrongdoing, or that gives advice or instruction on how to commit illicit acts. For example, \"how to shoplift\" would fit this category.
+    attr_accessor :illicit
+
+    # Content that includes instructions or advice that facilitate the planning or execution of wrongdoing that also includes violence, or that gives advice or instruction on the procurement of any weapon.
+    attr_accessor :illicit_violent
+
+    # Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders.
     attr_accessor :self_harm
 
+    # Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders.
+    attr_accessor :self_harm_intent
+
+    # Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts.
+    attr_accessor :self_harm_instructions
+
+    # Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness).
     attr_accessor :sexual
 
+    # Sexual content that includes an individual who is under 18 years old.
     attr_accessor :sexual_minors
 
+    # Content that depicts death, violence, or physical injury.
     attr_accessor :violence
 
+    # Content that depicts death, violence, or physical injury in graphic detail.
     attr_accessor :violence_graphic
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,7 +60,13 @@ module OpenApiOpenAIClient
       {
         :'hate' => :'hate',
         :'hate_threatening' => :'hate/threatening',
+        :'harassment' => :'harassment',
+        :'harassment_threatening' => :'harassment/threatening',
+        :'illicit' => :'illicit',
+        :'illicit_violent' => :'illicit/violent',
         :'self_harm' => :'self-harm',
+        :'self_harm_intent' => :'self-harm/intent',
+        :'self_harm_instructions' => :'self-harm/instructions',
         :'sexual' => :'sexual',
         :'sexual_minors' => :'sexual/minors',
         :'violence' => :'violence',
@@ -42,9 +74,14 @@ module OpenApiOpenAIClient
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -52,7 +89,13 @@ module OpenApiOpenAIClient
       {
         :'hate' => :'Boolean',
         :'hate_threatening' => :'Boolean',
+        :'harassment' => :'Boolean',
+        :'harassment_threatening' => :'Boolean',
+        :'illicit' => :'Boolean',
+        :'illicit_violent' => :'Boolean',
         :'self_harm' => :'Boolean',
+        :'self_harm_intent' => :'Boolean',
+        :'self_harm_instructions' => :'Boolean',
         :'sexual' => :'Boolean',
         :'sexual_minors' => :'Boolean',
         :'violence' => :'Boolean',
@@ -74,9 +117,10 @@ module OpenApiOpenAIClient
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::CreateModerationResponseResultsInnerCategories`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::CreateModerationResponseResultsInnerCategories`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -93,12 +137,48 @@ module OpenApiOpenAIClient
         self.hate_threatening = nil
       end
 
+      if attributes.key?(:'harassment')
+        self.harassment = attributes[:'harassment']
+      else
+        self.harassment = nil
+      end
+
+      if attributes.key?(:'harassment_threatening')
+        self.harassment_threatening = attributes[:'harassment_threatening']
+      else
+        self.harassment_threatening = nil
+      end
+
+      if attributes.key?(:'illicit')
+        self.illicit = attributes[:'illicit']
+      else
+        self.illicit = nil
+      end
+
+      if attributes.key?(:'illicit_violent')
+        self.illicit_violent = attributes[:'illicit_violent']
+      else
+        self.illicit_violent = nil
+      end
+
       if attributes.key?(:'self_harm')
         self.self_harm = attributes[:'self_harm']
       else
         self.self_harm = nil
       end
 
+      if attributes.key?(:'self_harm_intent')
+        self.self_harm_intent = attributes[:'self_harm_intent']
+      else
+        self.self_harm_intent = nil
+      end
+
+      if attributes.key?(:'self_harm_instructions')
+        self.self_harm_instructions = attributes[:'self_harm_instructions']
+      else
+        self.self_harm_instructions = nil
+      end
+
       if attributes.key?(:'sexual')
         self.sexual = attributes[:'sexual']
       else
@@ -137,10 +217,34 @@ module OpenApiOpenAIClient
         invalid_properties.push('invalid value for "hate_threatening", hate_threatening cannot be nil.')
       end
 
+      if @harassment.nil?
+        invalid_properties.push('invalid value for "harassment", harassment cannot be nil.')
+      end
+
+      if @harassment_threatening.nil?
+        invalid_properties.push('invalid value for "harassment_threatening", harassment_threatening cannot be nil.')
+      end
+
+      if @illicit.nil?
+        invalid_properties.push('invalid value for "illicit", illicit cannot be nil.')
+      end
+
+      if @illicit_violent.nil?
+        invalid_properties.push('invalid value for "illicit_violent", illicit_violent cannot be nil.')
+      end
+
       if @self_harm.nil?
         invalid_properties.push('invalid value for "self_harm", self_harm cannot be nil.')
       end
 
+      if @self_harm_intent.nil?
+        invalid_properties.push('invalid value for "self_harm_intent", self_harm_intent cannot be nil.')
+      end
+
+      if @self_harm_instructions.nil?
+        invalid_properties.push('invalid value for "self_harm_instructions", self_harm_instructions cannot be nil.')
+      end
+
       if @sexual.nil?
         invalid_properties.push('invalid value for "sexual", sexual cannot be nil.')
       end
@@ -166,7 +270,13 @@ module OpenApiOpenAIClient
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @hate.nil?
       return false if @hate_threatening.nil?
+      return false if @harassment.nil?
+      return false if @harassment_threatening.nil?
+      return false if @illicit.nil?
+      return false if @illicit_violent.nil?
       return false if @self_harm.nil?
+      return false if @self_harm_intent.nil?
+      return false if @self_harm_instructions.nil?
       return false if @sexual.nil?
       return false if @sexual_minors.nil?
       return false if @violence.nil?
@@ -174,6 +284,136 @@ module OpenApiOpenAIClient
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] hate Value to be assigned
+    def hate=(hate)
+      if hate.nil?
+        fail ArgumentError, 'hate cannot be nil'
+      end
+
+      @hate = hate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] hate_threatening Value to be assigned
+    def hate_threatening=(hate_threatening)
+      if hate_threatening.nil?
+        fail ArgumentError, 'hate_threatening cannot be nil'
+      end
+
+      @hate_threatening = hate_threatening
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] harassment Value to be assigned
+    def harassment=(harassment)
+      if harassment.nil?
+        fail ArgumentError, 'harassment cannot be nil'
+      end
+
+      @harassment = harassment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] harassment_threatening Value to be assigned
+    def harassment_threatening=(harassment_threatening)
+      if harassment_threatening.nil?
+        fail ArgumentError, 'harassment_threatening cannot be nil'
+      end
+
+      @harassment_threatening = harassment_threatening
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] illicit Value to be assigned
+    def illicit=(illicit)
+      if illicit.nil?
+        fail ArgumentError, 'illicit cannot be nil'
+      end
+
+      @illicit = illicit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] illicit_violent Value to be assigned
+    def illicit_violent=(illicit_violent)
+      if illicit_violent.nil?
+        fail ArgumentError, 'illicit_violent cannot be nil'
+      end
+
+      @illicit_violent = illicit_violent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] self_harm Value to be assigned
+    def self_harm=(self_harm)
+      if self_harm.nil?
+        fail ArgumentError, 'self_harm cannot be nil'
+      end
+
+      @self_harm = self_harm
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] self_harm_intent Value to be assigned
+    def self_harm_intent=(self_harm_intent)
+      if self_harm_intent.nil?
+        fail ArgumentError, 'self_harm_intent cannot be nil'
+      end
+
+      @self_harm_intent = self_harm_intent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] self_harm_instructions Value to be assigned
+    def self_harm_instructions=(self_harm_instructions)
+      if self_harm_instructions.nil?
+        fail ArgumentError, 'self_harm_instructions cannot be nil'
+      end
+
+      @self_harm_instructions = self_harm_instructions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sexual Value to be assigned
+    def sexual=(sexual)
+      if sexual.nil?
+        fail ArgumentError, 'sexual cannot be nil'
+      end
+
+      @sexual = sexual
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sexual_minors Value to be assigned
+    def sexual_minors=(sexual_minors)
+      if sexual_minors.nil?
+        fail ArgumentError, 'sexual_minors cannot be nil'
+      end
+
+      @sexual_minors = sexual_minors
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] violence Value to be assigned
+    def violence=(violence)
+      if violence.nil?
+        fail ArgumentError, 'violence cannot be nil'
+      end
+
+      @violence = violence
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] violence_graphic Value to be assigned
+    def violence_graphic=(violence_graphic)
+      if violence_graphic.nil?
+        fail ArgumentError, 'violence_graphic cannot be nil'
+      end
+
+      @violence_graphic = violence_graphic
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -181,7 +421,13 @@ module OpenApiOpenAIClient
       self.class == o.class &&
           hate == o.hate &&
           hate_threatening == o.hate_threatening &&
+          harassment == o.harassment &&
+          harassment_threatening == o.harassment_threatening &&
+          illicit == o.illicit &&
+          illicit_violent == o.illicit_violent &&
           self_harm == o.self_harm &&
+          self_harm_intent == o.self_harm_intent &&
+          self_harm_instructions == o.self_harm_instructions &&
           sexual == o.sexual &&
           sexual_minors == o.sexual_minors &&
           violence == o.violence &&
@@ -197,7 +443,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [hate, hate_threatening, self_harm, sexual, sexual_minors, violence, violence_graphic].hash
+      [hate, hate_threatening, harassment, harassment_threatening, illicit, illicit_violent, self_harm, self_harm_intent, self_harm_instructions, sexual, sexual_minors, violence, violence_graphic].hash
     end
 
     # Builds the object from hash
@@ -223,61 +469,6 @@ module OpenApiOpenAIClient
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = OpenApiOpenAIClient.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -294,24 +485,6 @@ module OpenApiOpenAIClient
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
 
 end