lluminary 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02594d2f6a20444f1e6609a1582ca06c29ecddaf12042a42fdf65621eb16fce3'
-  data.tar.gz: 20c476662fe4ab8dcc4fe403fd580b5d44323bc970f8c9830a7b32eb06589d4e
+  metadata.gz: 77729a2c4dc59717c0fd5c8fa8cf21df682bbaeff5c66e501f0e409cb8ac16c4
+  data.tar.gz: 46aa2188fcad140a7e7dfa2cc3d4bd5008d1bd5afbf70920bc3b211eb9018480
 SHA512:
-  metadata.gz: 5b0f2590d708746f35958ea556d6b6bd6d7e9d594505fc5b70178af317a9b6570b1ac9f4ab8580eee0d16776358fa7be7b65f4a3abc88cf14ce364c5410442bf
-  data.tar.gz: aad105c596b169ccb3ca0613d974b3883553d7296190c9906bda88f2b5b00b765a079364cb3b45ffaa94dbf9aa81e2b369aa3a236936eb756671785c32058d5d
+  metadata.gz: ed78898c62ab28d52136d470f5ccf398b3d5dcce8643af51348834877b3561ae3ca5b0ca1e7d12fbab6d0a8b677e7599c393dd9f678af970da5d3d5f01da9e24
+  data.tar.gz: 961371925c55006aedfe7b89d043aa10411f90b26fe1c67be356c2b81ebcc618417eb0fa1ff1cdf5dcd7344adb0e75b208d82e0ae256e0497c178c6f6d3569f9

data/lib/lluminary/config.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 module Lluminary
+  # Configuration class for Lluminary framework.
+  # Handles global settings and provider configurations.
+
   class Config
     def initialize
       @providers = {}
@@ -20,4 +25,4 @@ module Lluminary
       @providers = {}
     end
   end
-end 
+end

data/lib/lluminary/models/base.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Lluminary
+  module Models
+    # Base class for all LLM models.
+    # Defines the interface that all model classes must implement and provides
+    # default prompt formatting behavior.
+    class Base
+      # Checks if this model is compatible with a given provider
+      # @param provider_name [Symbol] The name of the provider to check
+      # @return [Boolean]
+      def compatible_with?(provider_name)
+        raise NotImplementedError, "Subclasses must implement #compatible_with?"
+      end
+
+      # Returns the name of the model
+      # @return [String]
+      def name
+        raise NotImplementedError, "Subclasses must implement #name"
+      end
+
+      def format_prompt(task)
+        <<~PROMPT
+          #{task.task_prompt.chomp}
+
+          #{output_preamble}
+          
+          #{format_field_descriptions(task.class.output_fields)}
+          
+          #{json_preamble}
+          
+          #{format_json_example(task.class.output_fields)}
+        PROMPT
+      end
+
+      private
+
+      def output_preamble
+        <<~PREAMBLE.chomp
+          You must respond with ONLY a valid JSON object. Do not include any other text, explanations, or formatting.
+          The JSON object must contain the following fields:
+        PREAMBLE
+      end
+
+      def json_preamble
+        "Your response must be ONLY this JSON object:"
+      end
+
+      def format_field_descriptions(fields)
+        fields
+          .map do |name, field|
+            desc = "# #{name}"
+            desc += "\nType: #{format_type(field)}"
+
+            desc += "\nDescription: #{field[:description].chomp}" if field[
+              :description
+            ]
+
+            if (validations = describe_validations(field[:validations]))
+              desc += "\nValidations: #{validations}"
+            end
+
+            desc += "\nExample: #{generate_example_value(name, field)}"
+            desc
+          end
+          .join("\n\n")
+      end
+
+      def describe_validations(validations)
+        return unless validations&.any?
+
+        validations
+          .map do |options|
+            case options.keys.first
+            when :presence
+              "must be present"
+            when :inclusion
+              "must be one of: #{options[:inclusion][:in].join(", ")}"
+            when :exclusion
+              "must not be one of: #{options[:exclusion][:in].join(", ")}"
+            when :format
+              "must match format: #{options[:format][:with]}"
+            when :length
+              describe_length_validation(options[:length])
+            when :numericality
+              describe_numericality_validation(options[:numericality])
+            when :comparison
+              describe_comparison_validation(options[:comparison])
+            when :absence
+              "must be absent"
+            end
+          end
+          .compact
+          .join(", ")
+      end
+
+      def describe_length_validation(options)
+        descriptions = []
+        if options[:minimum]
+          descriptions << "must be at least #{options[:minimum]} characters"
+        end
+        if options[:maximum]
+          descriptions << "must be at most #{options[:maximum]} characters"
+        end
+        if options[:is]
+          descriptions << "must be exactly #{options[:is]} characters"
+        end
+        if options[:in]
+          descriptions << "must be between #{options[:in].min} and #{options[:in].max} characters"
+        end
+        descriptions.join(", ")
+      end
+
+      def describe_numericality_validation(options)
+        descriptions = []
+        if options[:greater_than]
+          descriptions << "must be greater than #{options[:greater_than]}"
+        end
+        if options[:greater_than_or_equal_to]
+          descriptions << "must be greater than or equal to #{options[:greater_than_or_equal_to]}"
+        end
+        if options[:equal_to]
+          descriptions << "must be equal to #{options[:equal_to]}"
+        end
+        if options[:less_than]
+          descriptions << "must be less than #{options[:less_than]}"
+        end
+        if options[:less_than_or_equal_to]
+          descriptions << "must be less than or equal to #{options[:less_than_or_equal_to]}"
+        end
+        if options[:other_than]
+          descriptions << "must be other than #{options[:other_than]}"
+        end
+        if options[:in]
+          descriptions << "must be in: #{options[:in].to_a.join(", ")}"
+        end
+        descriptions << "must be odd" if options[:odd]
+        descriptions << "must be even" if options[:even]
+        descriptions.join(", ")
+      end
+
+      def describe_comparison_validation(options)
+        descriptions = []
+        if options[:greater_than]
+          descriptions << "must be greater than #{options[:greater_than]}"
+        end
+        if options[:greater_than_or_equal_to]
+          descriptions << "must be greater than or equal to #{options[:greater_than_or_equal_to]}"
+        end
+        if options[:equal_to]
+          descriptions << "must be equal to #{options[:equal_to]}"
+        end
+        if options[:less_than]
+          descriptions << "must be less than #{options[:less_than]}"
+        end
+        if options[:less_than_or_equal_to]
+          descriptions << "must be less than or equal to #{options[:less_than_or_equal_to]}"
+        end
+        if options[:other_than]
+          descriptions << "must be other than #{options[:other_than]}"
+        end
+        descriptions.join(", ")
+      end
+
+      def format_json_example(fields)
+        example =
+          fields.each_with_object({}) do |(name, field), hash|
+            hash[name] = generate_example_value(name, field)
+          end
+        JSON.pretty_generate(example)
+      end
+
+      def format_type(field)
+        type = field[:type]
+        case type
+        when :datetime
+          "datetime in ISO8601 format"
+        when :array
+          if field[:element_type]
+            "array of #{format_type(field[:element_type])}"
+          else
+            "array"
+          end
+        else
+          type.to_s
+        end
+      end
+
+      def generate_example_value(name, field)
+        case field[:type]
+        when :string
+          "your #{name} here"
+        when :integer
+          0
+        when :datetime
+          "2024-01-01T12:00:00+00:00"
+        when :boolean
+          true
+        when :float
+          0.0
+        when :array
+          generate_array_example(name, field)
+        end
+      end
+
+      def generate_array_example(name, field)
+        return [] unless field[:element_type]
+
+        case field[:element_type][:type]
+        when :string
+          [
+            "first #{name.to_s.singularize}",
+            "second #{name.to_s.singularize}",
+            "..."
+          ]
+        when :integer
+          [1, 2, 3]
+        when :float
+          [1.0, 2.0, 3.0]
+        when :boolean
+          [true, false, true]
+        when :datetime
+          %w[2024-01-01T12:00:00+00:00 2024-01-02T12:00:00+00:00]
+        when :array
+          if field[:element_type][:element_type]
+            inner_example = generate_array_example("item", field[:element_type])
+            [inner_example, inner_example]
+          else
+            [["..."], ["..."]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lluminary/models/bedrock/amazon_nova_pro_v1.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lluminary
+  module Models
+    module Bedrock
+      class AmazonNovaProV1 < Lluminary::Models::Bedrock::Base
+        NAME = "amazon.nova-pro-v1"
+        VERSIONS = %w[0].freeze
+        CONTEXT_WINDOWS = %w[24k 300k].freeze
+
+        def compatible_with?(provider_name)
+          provider_name == :bedrock
+        end
+      end
+    end
+  end
+end

data/lib/lluminary/models/bedrock/anthropic_claude_instant_v1.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lluminary
+  module Models
+    module Bedrock
+      class AnthropicClaudeInstantV1 < Lluminary::Models::Bedrock::Base
+        NAME = "anthropic.claude-instant-v1"
+
+        def compatible_with?(provider_name)
+          provider_name == :bedrock
+        end
+      end
+    end
+  end
+end

data/lib/lluminary/models/bedrock/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lluminary
+  module Models
+    module Bedrock
+      # TODO: test me
+      class Base < Lluminary::Models::Base
+        VERSIONS = [].freeze
+        CONTEXT_WINDOWS = [].freeze
+
+        def default_version
+          self.class::VERSIONS.last
+        end
+
+        def default_context_window
+          nil
+        end
+
+        def name
+          [
+            self.class::NAME,
+            default_version,
+            default_context_window
+          ].compact.join(":")
+        end
+      end
+    end
+  end
+end

data/lib/lluminary/models/openai/gpt35_turbo.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lluminary
+  module Models
+    module OpenAi
+      # Model class for OpenAI's GPT-3.5 Turbo
+      class Gpt35Turbo < Base
+        NAME = "gpt-3.5-turbo"
+
+        def compatible_with?(provider_name)
+          provider_name == :openai
+        end
+
+        def name
+          NAME
+        end
+      end
+    end
+  end
+end

data/lib/lluminary/provider_error.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Lluminary
   class ProviderError < StandardError
   end
-end 
+end

data/lib/lluminary/providers/base.rb

@@ -1,15 +1,32 @@
+# frozen_string_literal: true
+
 module Lluminary
   module Providers
+    # Base class for all LLM providers.
+    # Defines the interface that all providers must implement.
     class Base
+      # The symbolic name of the provider. Must be overridden by subclasses.
+      NAME = :base
+
       attr_reader :config
 
-      def initialize(**config)
-        @config = config
+      def initialize(**config_overrides)
+        @config = default_provider_config.merge(config_overrides)
       end
 
       def call(prompt, task)
         raise NotImplementedError, "Subclasses must implement #call"
       end
+
+      def models
+        raise NotImplementedError, "Subclasses must implement #models"
+      end
+
+      private
+
+      def default_provider_config
+        Lluminary.config.provider_config(self.class::NAME)
+      end
     end
   end
-end 
+end

data/lib/lluminary/providers/bedrock.rb

@@ -1,51 +1,71 @@
-require 'aws-sdk-bedrockruntime'
-require 'json'
-require_relative '../provider_error'
-
-require 'pry-byebug'
+# frozen_string_literal: true
+require "aws-sdk-bedrockruntime"
+require "aws-sdk-bedrock"
+require "json"
+require_relative "../provider_error"
 
 module Lluminary
   module Providers
+    # Provider for AWS Bedrock models.
+    # Implements the Base provider interface for AWS Bedrock's API.
     class Bedrock < Base
-      DEFAULT_MODEL_ID = 'anthropic.claude-instant-v1'
+      NAME = :bedrock
+      DEFAULT_MODEL = Models::Bedrock::AnthropicClaudeInstantV1
 
       attr_reader :client, :config
 
-      def initialize(**config)
+      def initialize(**config_overrides)
         super
-        @config = config
+        @config = { model: DEFAULT_MODEL }.merge(config)
 
-        @client = Aws::BedrockRuntime::Client.new(
-          region: config[:region],
-          credentials: Aws::Credentials.new(
-            config[:access_key_id],
-            config[:secret_access_key]
+        @client =
+          Aws::BedrockRuntime::Client.new(
+            region: config[:region],
+            credentials:
+              Aws::Credentials.new(
+                config[:access_key_id],
+                config[:secret_access_key]
+              )
           )
-        )
       end
 
-      def call(prompt, task)
-        response = @client.converse(
-          model_id: config[:model_id] || DEFAULT_MODEL_ID,
-          messages: [
-            {
-              role: 'user',
-              content: [{text: prompt}]
-            }
-          ]
-        )
+      def call(prompt, _task)
+        response =
+          client.converse(
+            model_id: model.name,
+            messages: [{ role: "user", content: [{ text: prompt }] }]
+          )
 
         content = response.dig(:output, :message, :content, 0, :text)
-        
-        { 
+
+        {
           raw: content,
-          parsed: begin
-            JSON.parse(content) if content
-          rescue JSON::ParserError
-            nil
-          end
+          parsed:
+            begin
+              JSON.parse(content) if content
+            rescue JSON::ParserError
+              nil
+            end
         }
       end
+
+      def model
+        @model ||= config[:model].new
+      end
+
+      def models
+        models_client =
+          Aws::Bedrock::Client.new(
+            region: config[:region],
+            credentials:
+              Aws::Credentials.new(
+                config[:access_key_id],
+                config[:secret_access_key]
+              )
+          )
+        response = models_client.list_foundation_models
+        response.foundation_models.map(&:model_id)
+      end
     end
   end
-end 
+end

data/lib/lluminary/providers/openai.rb

@@ -1,40 +1,57 @@
-require 'openai'
-require 'json'
-require_relative '../provider_error'
+# frozen_string_literal: true
+require "openai"
+require "json"
+require_relative "../provider_error"
 
 module Lluminary
   module Providers
+    # Provider for OpenAI's GPT models.
+    # Implements the Base provider interface for OpenAI's API.
     class OpenAI < Base
-      DEFAULT_MODEL = "gpt-3.5-turbo"
+      NAME = :openai
+      DEFAULT_MODEL = Models::OpenAi::Gpt35Turbo
 
       attr_reader :client, :config
 
-      def initialize(**config)
+      def initialize(**config_overrides)
         super
-        @config = config
+        @config = { model: DEFAULT_MODEL }.merge(config)
         @client = ::OpenAI::Client.new(access_token: config[:api_key])
       end
 
-      def call(prompt, task)
-        response = @client.chat(
-          parameters: {
-            model: config[:model] || DEFAULT_MODEL,
-            messages: [{ role: "user", content: prompt }],
-            response_format: { type: "json_object" }
-          }
-        )
-
-        content = response.dig('choices', 0, 'message', 'content')
-        
-        { 
+      def call(prompt, _task)
+        response =
+          client.chat(
+            parameters: {
+              model: model.class::NAME,
+              messages: [{ role: "user", content: prompt }],
+              response_format: {
+                type: "json_object"
+              }
+            }
+          )
+
+        content = response.dig("choices", 0, "message", "content")
+
+        {
           raw: content,
-          parsed: begin
-            JSON.parse(content) if content
-          rescue JSON::ParserError
-            nil
-          end
+          parsed:
+            begin
+              JSON.parse(content) if content
+            rescue JSON::ParserError
+              nil
+            end
         }
       end
+
+      def model
+        @model ||= config[:model].new
+      end
+
+      def models
+        response = @client.models.list
+        response["data"].map { |model| model["id"] }
+      end
     end
   end
-end 
+end

data/lib/lluminary/providers/test.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module Lluminary
   module Providers
+    # Test provider for development and testing.
+    # Returns predefined responses for testing purposes.
     class Test < Base
-      def initialize(**config)
-        super
-      end
+      NAME = :test
 
-      def call(prompt, task)
+      def call(_prompt, task)
         response = generate_response(task.class.output_fields)
-        raw_response = JSON.pretty_generate(response).gsub(/\n\s*/, '')
-        {
-          raw: raw_response,
-          parsed: JSON.parse(raw_response)
-        }
+        raw_response = JSON.pretty_generate(response).gsub(/\n\s*/, "")
+        { raw: raw_response, parsed: JSON.parse(raw_response) }
+      end
+
+      def model
+        @model ||= Lluminary::Models::Base.new
       end
 
       private
 
       def generate_response(fields)
-        fields.each_with_object({}) do |(name, field), hash|
-          hash[name] = generate_value(field[:type])
-        end
+        fields.transform_values { |field| generate_value(field[:type]) }
       end
 
       def generate_value(type)
@@ -34,4 +35,4 @@ module Lluminary
       end
     end
   end
-end 
+end

data/lib/lluminary/result.rb

@@ -1,6 +1,9 @@
-require 'ostruct'
+# frozen_string_literal: true
+require "ostruct"
 
 module Lluminary
+  # Represents the result of a task execution.
+  # Contains the output data and any metadata about the execution.
   class Result
     attr_reader :raw_response, :output, :prompt
 
@@ -10,4 +13,4 @@ module Lluminary
       @prompt = prompt
     end
   end
-end 
+end