litellm_client 1.0.0

data/lib/litellm_client/models/litellm_params.rb

@@ -0,0 +1,632 @@
+=begin
+#LiteLLM API
+
+#Proxy Server to call 100+ LLMs in the OpenAI format. [**Customize Swagger Docs**](https://docs.litellm.ai/docs/proxy/enterprise#swagger-docs---custom-routes--branding)  👉 [```LiteLLM Admin Panel on /ui```](/ui/). Create, Edit Keys with SSO  💸 [```LiteLLM Model Cost Map```](https://models.litellm.ai/).
+
+The version of the OpenAPI document: 1.72.6
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module LiteLLMClient
+  class LitellmParams
+    attr_accessor :lasso_user_id
+
+    attr_accessor :lasso_conversation_id
+
+    attr_accessor :api_key
+
+    attr_accessor :api_base
+
+    attr_accessor :project_id
+
+    attr_accessor :payload
+
+    attr_accessor :breakdown
+
+    attr_accessor :metadata
+
+    attr_accessor :dev_info
+
+    attr_accessor :guardrail_identifier
+
+    attr_accessor :guardrail_version
+
+    attr_accessor :aws_region_name
+
+    attr_accessor :aws_access_key_id
+
+    attr_accessor :aws_secret_access_key
+
+    attr_accessor :aws_session_token
+
+    attr_accessor :aws_session_name
+
+    attr_accessor :aws_profile_name
+
+    attr_accessor :aws_role_name
+
+    attr_accessor :aws_web_identity_token
+
+    attr_accessor :aws_sts_endpoint
+
+    attr_accessor :aws_bedrock_runtime_endpoint
+
+    attr_accessor :presidio_analyzer_api_base
+
+    attr_accessor :presidio_anonymizer_api_base
+
+    attr_accessor :output_parse_pii
+
+    attr_accessor :presidio_language
+
+    attr_accessor :pii_entities_config
+
+    attr_accessor :presidio_ad_hoc_recognizers
+
+    attr_accessor :mock_redacted_text
+
+    # The type of guardrail integration to use
+    attr_accessor :guardrail
+
+    attr_accessor :mode
+
+    attr_accessor :category_thresholds
+
+    attr_accessor :detect_secrets_config
+
+    attr_accessor :guard_name
+
+    attr_accessor :default_on
+
+    attr_accessor :mask_request_content
+
+    attr_accessor :mask_response_content
+
+    attr_accessor :pangea_input_recipe
+
+    attr_accessor :pangea_output_recipe
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'lasso_user_id' => :'lasso_user_id',
+        :'lasso_conversation_id' => :'lasso_conversation_id',
+        :'api_key' => :'api_key',
+        :'api_base' => :'api_base',
+        :'project_id' => :'project_id',
+        :'payload' => :'payload',
+        :'breakdown' => :'breakdown',
+        :'metadata' => :'metadata',
+        :'dev_info' => :'dev_info',
+        :'guardrail_identifier' => :'guardrailIdentifier',
+        :'guardrail_version' => :'guardrailVersion',
+        :'aws_region_name' => :'aws_region_name',
+        :'aws_access_key_id' => :'aws_access_key_id',
+        :'aws_secret_access_key' => :'aws_secret_access_key',
+        :'aws_session_token' => :'aws_session_token',
+        :'aws_session_name' => :'aws_session_name',
+        :'aws_profile_name' => :'aws_profile_name',
+        :'aws_role_name' => :'aws_role_name',
+        :'aws_web_identity_token' => :'aws_web_identity_token',
+        :'aws_sts_endpoint' => :'aws_sts_endpoint',
+        :'aws_bedrock_runtime_endpoint' => :'aws_bedrock_runtime_endpoint',
+        :'presidio_analyzer_api_base' => :'presidio_analyzer_api_base',
+        :'presidio_anonymizer_api_base' => :'presidio_anonymizer_api_base',
+        :'output_parse_pii' => :'output_parse_pii',
+        :'presidio_language' => :'presidio_language',
+        :'pii_entities_config' => :'pii_entities_config',
+        :'presidio_ad_hoc_recognizers' => :'presidio_ad_hoc_recognizers',
+        :'mock_redacted_text' => :'mock_redacted_text',
+        :'guardrail' => :'guardrail',
+        :'mode' => :'mode',
+        :'category_thresholds' => :'category_thresholds',
+        :'detect_secrets_config' => :'detect_secrets_config',
+        :'guard_name' => :'guard_name',
+        :'default_on' => :'default_on',
+        :'mask_request_content' => :'mask_request_content',
+        :'mask_response_content' => :'mask_response_content',
+        :'pangea_input_recipe' => :'pangea_input_recipe',
+        :'pangea_output_recipe' => :'pangea_output_recipe'
+      }
+    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
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'lasso_user_id' => :'String',
+        :'lasso_conversation_id' => :'String',
+        :'api_key' => :'String',
+        :'api_base' => :'String',
+        :'project_id' => :'String',
+        :'payload' => :'Boolean',
+        :'breakdown' => :'Boolean',
+        :'metadata' => :'Hash<String, Object>',
+        :'dev_info' => :'Boolean',
+        :'guardrail_identifier' => :'String',
+        :'guardrail_version' => :'String',
+        :'aws_region_name' => :'String',
+        :'aws_access_key_id' => :'String',
+        :'aws_secret_access_key' => :'String',
+        :'aws_session_token' => :'String',
+        :'aws_session_name' => :'String',
+        :'aws_profile_name' => :'String',
+        :'aws_role_name' => :'String',
+        :'aws_web_identity_token' => :'String',
+        :'aws_sts_endpoint' => :'String',
+        :'aws_bedrock_runtime_endpoint' => :'String',
+        :'presidio_analyzer_api_base' => :'String',
+        :'presidio_anonymizer_api_base' => :'String',
+        :'output_parse_pii' => :'Boolean',
+        :'presidio_language' => :'String',
+        :'pii_entities_config' => :'Hash<String, PiiAction>',
+        :'presidio_ad_hoc_recognizers' => :'String',
+        :'mock_redacted_text' => :'Hash<String, Object>',
+        :'guardrail' => :'String',
+        :'mode' => :'Mode1',
+        :'category_thresholds' => :'LakeraCategoryThresholds',
+        :'detect_secrets_config' => :'Hash<String, Object>',
+        :'guard_name' => :'String',
+        :'default_on' => :'Boolean',
+        :'mask_request_content' => :'Boolean',
+        :'mask_response_content' => :'Boolean',
+        :'pangea_input_recipe' => :'String',
+        :'pangea_output_recipe' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'lasso_user_id',
+        :'lasso_conversation_id',
+        :'api_key',
+        :'api_base',
+        :'project_id',
+        :'payload',
+        :'breakdown',
+        :'metadata',
+        :'dev_info',
+        :'guardrail_identifier',
+        :'guardrail_version',
+        :'aws_region_name',
+        :'aws_access_key_id',
+        :'aws_secret_access_key',
+        :'aws_session_token',
+        :'aws_session_name',
+        :'aws_profile_name',
+        :'aws_role_name',
+        :'aws_web_identity_token',
+        :'aws_sts_endpoint',
+        :'aws_bedrock_runtime_endpoint',
+        :'presidio_analyzer_api_base',
+        :'presidio_anonymizer_api_base',
+        :'output_parse_pii',
+        :'presidio_language',
+        :'pii_entities_config',
+        :'presidio_ad_hoc_recognizers',
+        :'mock_redacted_text',
+        :'category_thresholds',
+        :'detect_secrets_config',
+        :'guard_name',
+        :'default_on',
+        :'mask_request_content',
+        :'mask_response_content',
+        :'pangea_input_recipe',
+        :'pangea_output_recipe'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `LiteLLMClient::LitellmParams` initialize method"
+      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 (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `LiteLLMClient::LitellmParams`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'lasso_user_id')
+        self.lasso_user_id = attributes[:'lasso_user_id']
+      end
+
+      if attributes.key?(:'lasso_conversation_id')
+        self.lasso_conversation_id = attributes[:'lasso_conversation_id']
+      end
+
+      if attributes.key?(:'api_key')
+        self.api_key = attributes[:'api_key']
+      end
+
+      if attributes.key?(:'api_base')
+        self.api_base = attributes[:'api_base']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'payload')
+        self.payload = attributes[:'payload']
+      end
+
+      if attributes.key?(:'breakdown')
+        self.breakdown = attributes[:'breakdown']
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'dev_info')
+        self.dev_info = attributes[:'dev_info']
+      end
+
+      if attributes.key?(:'guardrail_identifier')
+        self.guardrail_identifier = attributes[:'guardrail_identifier']
+      end
+
+      if attributes.key?(:'guardrail_version')
+        self.guardrail_version = attributes[:'guardrail_version']
+      end
+
+      if attributes.key?(:'aws_region_name')
+        self.aws_region_name = attributes[:'aws_region_name']
+      end
+
+      if attributes.key?(:'aws_access_key_id')
+        self.aws_access_key_id = attributes[:'aws_access_key_id']
+      end
+
+      if attributes.key?(:'aws_secret_access_key')
+        self.aws_secret_access_key = attributes[:'aws_secret_access_key']
+      end
+
+      if attributes.key?(:'aws_session_token')
+        self.aws_session_token = attributes[:'aws_session_token']
+      end
+
+      if attributes.key?(:'aws_session_name')
+        self.aws_session_name = attributes[:'aws_session_name']
+      end
+
+      if attributes.key?(:'aws_profile_name')
+        self.aws_profile_name = attributes[:'aws_profile_name']
+      end
+
+      if attributes.key?(:'aws_role_name')
+        self.aws_role_name = attributes[:'aws_role_name']
+      end
+
+      if attributes.key?(:'aws_web_identity_token')
+        self.aws_web_identity_token = attributes[:'aws_web_identity_token']
+      end
+
+      if attributes.key?(:'aws_sts_endpoint')
+        self.aws_sts_endpoint = attributes[:'aws_sts_endpoint']
+      end
+
+      if attributes.key?(:'aws_bedrock_runtime_endpoint')
+        self.aws_bedrock_runtime_endpoint = attributes[:'aws_bedrock_runtime_endpoint']
+      end
+
+      if attributes.key?(:'presidio_analyzer_api_base')
+        self.presidio_analyzer_api_base = attributes[:'presidio_analyzer_api_base']
+      end
+
+      if attributes.key?(:'presidio_anonymizer_api_base')
+        self.presidio_anonymizer_api_base = attributes[:'presidio_anonymizer_api_base']
+      end
+
+      if attributes.key?(:'output_parse_pii')
+        self.output_parse_pii = attributes[:'output_parse_pii']
+      end
+
+      if attributes.key?(:'presidio_language')
+        self.presidio_language = attributes[:'presidio_language']
+      end
+
+      if attributes.key?(:'pii_entities_config')
+        if (value = attributes[:'pii_entities_config']).is_a?(Hash)
+          self.pii_entities_config = value
+        end
+      end
+
+      if attributes.key?(:'presidio_ad_hoc_recognizers')
+        self.presidio_ad_hoc_recognizers = attributes[:'presidio_ad_hoc_recognizers']
+      end
+
+      if attributes.key?(:'mock_redacted_text')
+        if (value = attributes[:'mock_redacted_text']).is_a?(Hash)
+          self.mock_redacted_text = value
+        end
+      end
+
+      if attributes.key?(:'guardrail')
+        self.guardrail = attributes[:'guardrail']
+      else
+        self.guardrail = nil
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'category_thresholds')
+        self.category_thresholds = attributes[:'category_thresholds']
+      end
+
+      if attributes.key?(:'detect_secrets_config')
+        if (value = attributes[:'detect_secrets_config']).is_a?(Hash)
+          self.detect_secrets_config = value
+        end
+      end
+
+      if attributes.key?(:'guard_name')
+        self.guard_name = attributes[:'guard_name']
+      end
+
+      if attributes.key?(:'default_on')
+        self.default_on = attributes[:'default_on']
+      end
+
+      if attributes.key?(:'mask_request_content')
+        self.mask_request_content = attributes[:'mask_request_content']
+      end
+
+      if attributes.key?(:'mask_response_content')
+        self.mask_response_content = attributes[:'mask_response_content']
+      end
+
+      if attributes.key?(:'pangea_input_recipe')
+        self.pangea_input_recipe = attributes[:'pangea_input_recipe']
+      end
+
+      if attributes.key?(:'pangea_output_recipe')
+        self.pangea_output_recipe = attributes[:'pangea_output_recipe']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @guardrail.nil?
+        invalid_properties.push('invalid value for "guardrail", guardrail cannot be nil.')
+      end
+
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @guardrail.nil?
+      return false if @mode.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] guardrail Value to be assigned
+    def guardrail=(guardrail)
+      if guardrail.nil?
+        fail ArgumentError, 'guardrail cannot be nil'
+      end
+
+      @guardrail = guardrail
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mode Value to be assigned
+    def mode=(mode)
+      if mode.nil?
+        fail ArgumentError, 'mode cannot be nil'
+      end
+
+      @mode = mode
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          lasso_user_id == o.lasso_user_id &&
+          lasso_conversation_id == o.lasso_conversation_id &&
+          api_key == o.api_key &&
+          api_base == o.api_base &&
+          project_id == o.project_id &&
+          payload == o.payload &&
+          breakdown == o.breakdown &&
+          metadata == o.metadata &&
+          dev_info == o.dev_info &&
+          guardrail_identifier == o.guardrail_identifier &&
+          guardrail_version == o.guardrail_version &&
+          aws_region_name == o.aws_region_name &&
+          aws_access_key_id == o.aws_access_key_id &&
+          aws_secret_access_key == o.aws_secret_access_key &&
+          aws_session_token == o.aws_session_token &&
+          aws_session_name == o.aws_session_name &&
+          aws_profile_name == o.aws_profile_name &&
+          aws_role_name == o.aws_role_name &&
+          aws_web_identity_token == o.aws_web_identity_token &&
+          aws_sts_endpoint == o.aws_sts_endpoint &&
+          aws_bedrock_runtime_endpoint == o.aws_bedrock_runtime_endpoint &&
+          presidio_analyzer_api_base == o.presidio_analyzer_api_base &&
+          presidio_anonymizer_api_base == o.presidio_anonymizer_api_base &&
+          output_parse_pii == o.output_parse_pii &&
+          presidio_language == o.presidio_language &&
+          pii_entities_config == o.pii_entities_config &&
+          presidio_ad_hoc_recognizers == o.presidio_ad_hoc_recognizers &&
+          mock_redacted_text == o.mock_redacted_text &&
+          guardrail == o.guardrail &&
+          mode == o.mode &&
+          category_thresholds == o.category_thresholds &&
+          detect_secrets_config == o.detect_secrets_config &&
+          guard_name == o.guard_name &&
+          default_on == o.default_on &&
+          mask_request_content == o.mask_request_content &&
+          mask_response_content == o.mask_response_content &&
+          pangea_input_recipe == o.pangea_input_recipe &&
+          pangea_output_recipe == o.pangea_output_recipe
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [lasso_user_id, lasso_conversation_id, api_key, api_base, project_id, payload, breakdown, metadata, dev_info, guardrail_identifier, guardrail_version, aws_region_name, aws_access_key_id, aws_secret_access_key, aws_session_token, aws_session_name, aws_profile_name, aws_role_name, aws_web_identity_token, aws_sts_endpoint, aws_bedrock_runtime_endpoint, presidio_analyzer_api_base, presidio_anonymizer_api_base, output_parse_pii, presidio_language, pii_entities_config, presidio_ad_hoc_recognizers, mock_redacted_text, guardrail, mode, category_thresholds, detect_secrets_config, guard_name, default_on, mask_request_content, mask_response_content, pangea_input_recipe, pangea_output_recipe].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      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 = LiteLLMClient.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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      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