cuadra-ai-sdk 1.0.1

data/lib/cuadra_ai/models/base_model.rb

@@ -0,0 +1,110 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/cuadra_ai/models/chat.rb

@@ -0,0 +1,102 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # Chat Model.
+  class Chat < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Model name
+    # @return [String]
+    attr_accessor :model
+
+    # Request content
+    # @return [Array[ContentEx]]
+    attr_accessor :content
+
+    # If you want to keep context between request, otherwise leave it empty, you
+    # get one with every chat you create.
+    # @return [String]
+    attr_accessor :chat_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['model'] = 'model'
+      @_hash['content'] = 'content'
+      @_hash['chat_id'] = 'chatId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        chat_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(model:, content:, chat_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @model = model
+      @content = content
+      @chat_id = chat_id unless chat_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      model = hash.key?('model') ? hash['model'] : nil
+      # Parameter is an array, so we need to iterate through it
+      content = nil
+      unless hash['content'].nil?
+        content = []
+        hash['content'].each do |structure|
+          content << (ContentEx.from_hash(structure) if structure)
+        end
+      end
+
+      content = nil unless hash.key?('content')
+      chat_id = hash.key?('chatId') ? hash['chatId'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Chat.new(model: model,
+               content: content,
+               chat_id: chat_id,
+               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} model: #{@model}, content: #{@content}, chat_id: #{@chat_id},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} model: #{@model.inspect}, content: #{@content.inspect}, chat_id:"\
+      " #{@chat_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/chat_response_ex.rb

@@ -0,0 +1,106 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # ChatResponseEx Model.
+  class ChatResponseEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Output generated by the AI to resolve the request
+    # @return [String]
+    attr_accessor :output
+
+    # Confidence score of how accurate is the output regarding your request
+    # @return [Float]
+    attr_accessor :confidence_score
+
+    # Model used to resolve your query
+    # @return [String]
+    attr_accessor :model
+
+    # This is the token usage result of your request
+    # @return [UsageEx]
+    attr_accessor :usage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['output'] = 'output'
+      @_hash['confidence_score'] = 'confidenceScore'
+      @_hash['model'] = 'model'
+      @_hash['usage'] = 'usage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        output
+        confidence_score
+        model
+        usage
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(output: SKIP, confidence_score: SKIP, model: SKIP,
+                   usage: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @output = output unless output == SKIP
+      @confidence_score = confidence_score unless confidence_score == SKIP
+      @model = model unless model == SKIP
+      @usage = usage unless usage == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      output = hash.key?('output') ? hash['output'] : SKIP
+      confidence_score =
+        hash.key?('confidenceScore') ? hash['confidenceScore'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      usage = UsageEx.from_hash(hash['usage']) if hash['usage']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ChatResponseEx.new(output: output,
+                         confidence_score: confidence_score,
+                         model: model,
+                         usage: usage,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} output: #{@output}, confidence_score: #{@confidence_score}, model:"\
+      " #{@model}, usage: #{@usage}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} output: #{@output.inspect}, confidence_score: #{@confidence_score.inspect},"\
+      " model: #{@model.inspect}, usage: #{@usage.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/content_ex.rb

@@ -0,0 +1,86 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # Request content
+  class ContentEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Text is the task you want the AI to solve.
+    # @return [String]
+    attr_accessor :text
+
+    # Input Reference is the name of the file, if you're request is from a type
+    # other than text, and it's required for most types. It has to contain the
+    # same name as the file attached in the request.
+    # @return [InlineDataEx]
+    attr_accessor :inline_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['text'] = 'text'
+      @_hash['inline_data'] = 'inlineData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        inline_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(text:, inline_data: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @text = text
+      @inline_data = inline_data unless inline_data == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      text = hash.key?('text') ? hash['text'] : nil
+      inline_data = InlineDataEx.from_hash(hash['inlineData']) if hash['inlineData']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ContentEx.new(text: text,
+                    inline_data: inline_data,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} text: #{@text}, inline_data: #{@inline_data}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} text: #{@text.inspect}, inline_data: #{@inline_data.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/embed.rb

@@ -0,0 +1,100 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # Embed Model.
+  class Embed < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Model name
+    # @return [String]
+    attr_accessor :model
+
+    # Request content
+    # @return [Array[ContentEx]]
+    attr_accessor :content
+
+    # The purpose of the embed, it could be 'search_document', 'search_query',
+    # 'classification', o 'clustering'.
+    # @return [String]
+    attr_accessor :purpose
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['model'] = 'model'
+      @_hash['content'] = 'content'
+      @_hash['purpose'] = 'purpose'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(model:, content:, purpose:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @model = model
+      @content = content
+      @purpose = purpose
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      model = hash.key?('model') ? hash['model'] : nil
+      # Parameter is an array, so we need to iterate through it
+      content = nil
+      unless hash['content'].nil?
+        content = []
+        hash['content'].each do |structure|
+          content << (ContentEx.from_hash(structure) if structure)
+        end
+      end
+
+      content = nil unless hash.key?('content')
+      purpose = hash.key?('purpose') ? hash['purpose'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Embed.new(model: model,
+                content: content,
+                purpose: purpose,
+                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} model: #{@model}, content: #{@content}, purpose: #{@purpose},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} model: #{@model.inspect}, content: #{@content.inspect}, purpose:"\
+      " #{@purpose.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/embed_response_ex.rb

@@ -0,0 +1,85 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # EmbedResponseEx Model.
+  class EmbedResponseEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Embed id
+    # @return [String]
+    attr_accessor :id
+
+    # This is the token usage result of your request
+    # @return [UsageEx]
+    attr_accessor :usage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['usage'] = 'usage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        usage
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, usage: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @usage = usage unless usage == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      usage = UsageEx.from_hash(hash['usage']) if hash['usage']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      EmbedResponseEx.new(id: id,
+                          usage: usage,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, usage: #{@usage}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, usage: #{@usage.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/inline_data_ex.rb

@@ -0,0 +1,87 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # Input Reference is the name of the file, if you're request is from a type
+  # other than text, and it's required for most types. It has to contain the
+  # same name as the file attached in the request.
+  class InlineDataEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :mime_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mime_type'] = 'mimeType'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mime_type
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mime_type: SKIP, data: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @mime_type = mime_type unless mime_type == SKIP
+      @data = data unless data == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      mime_type = hash.key?('mimeType') ? hash['mimeType'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      InlineDataEx.new(mime_type: mime_type,
+                       data: data,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mime_type: #{@mime_type}, data: #{@data}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mime_type: #{@mime_type.inspect}, data: #{@data.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end