ai_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12bef21b23a46a47cc409042afd5eaae36d6cf1cdd2fae47f12fd0b958ed961
-  data.tar.gz: 0c70c7f7e562da50876ee65c1f1de81f6ee7d37e97a2a7c114bb692ce5d6155d
+  metadata.gz: 107e9d57f175adc72178f48365a833a4dab7fbe71088169774429f43624d7d9c
+  data.tar.gz: d308008540c4fbf309235c31d60b1a98b14a608a0f69d7ee1bac6911f34dad47
 SHA512:
-  metadata.gz: 56d14adae8ab29719083dc7bb63edf33fa625237274edef043b3738f39757fa0c15983232c9aab0a2afbf8db33cbcafc89ed0cb39d0180d045e3c2f6f467a5fe
-  data.tar.gz: 5c3d314a10a6aa6f10a51b6f8eaf574dea6d108feb5b5ec64f47fb0e494cc1ebe865a7b2fbc9401aada23c692cae2346a48dbcf062e84a202e080f25f0790d9d
+  metadata.gz: b001c640758c846f2372354660d4a4f4c7ef4a6c4671bbd743fcc713d543faff1fe54ff2e341285ec57dbaf284db3e3a18a50cbd6b420fd01ac911112a93ae8a
+  data.tar.gz: 0055623e374bb4cf111a234712e9ac1441d6ddb541f2f7ebadc604c255e27bdd6ad14d1b2a81d56cb6e2797e01f3d3398eb4b4b3e6c7d04802dadf620ecb0390

data/.irbrc

@@ -0,0 +1,3 @@
+# .irbrc
+
+require_relative 'lib/ai_client'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-10-02
+## Released
+### [0.2.0] - 2024-10-04
+- Configuration is more robust.  Still room for improvement.
+
+### [0.1.0] - 2024-10-02
 
 - Initial working release

data/README.md

@@ -41,6 +41,30 @@ c1 = AiClient.new('nomic-embeddings-text')
 c2 = AiClient.new('gpt-4o-mini')
 ```
 
+### Configuration
+
+There is an internal hard-coded configuration default.  That default is duppled into a class-level configuration which can be over-ridden with a class-level config block like this ...
+
+```ruby
+AiClient.configure do |config|
+  config.some_item = some_value
+end
+```
+
+Every instance of the AiClient inherents the class-level configuration; however, the instance configuration can also be over-ridden also with a block like this ...
+
+```ruby
+client = AiClient.new('super-ai-overlord-model') do |config|
+  config.some_item = some_value
+end
+```
+
+But wait, there's more.  You can also load a YAML file as a configuration of an instance like this ...
+
+```ruby
+client = AiClient.new('baby-model', config: 'path/to/file.yml')
+```
+
 ### What Now?
 
 TODO: Document the methods and their options.

data/lib/ai_client/configuration.rb

@@ -1,84 +1,83 @@
 # ai_client/configuration.rb
+#
+# Design Objective:
+# AiClient.configure do |config|
+#   # global config items that over-ride the defaults
+# end
+#
+# client = AiClient.new(...) do
+#   # client specific config items that over-ride the global config
+# end 
 
+require 'hashie'
 require 'logger'
 
 class AiClient
-  # TODO: Need a centralized service where
-  #       metadata about LLMs are available
-  #       via and API call.  Would hope that
-  #       the providers would add a "list"
-  #       endpoint to their API which would
-  #       return the metadata for all of their
-  #       models.
-
-  PROVIDER_PATTERNS = {
-    anthropic:  /^claude/i,
-    openai:     /^(gpt|davinci|curie|babbage|ada|whisper|tts|dall-e)/i,
-    google:     /^(gemini|palm)/i,
-    mistral:    /^(mistral|codestral)/i,
-    localai:    /^local-/i,
-    ollama:     /(llama-|nomic)/i
-  }
-
-  MODEL_TYPES = {
-    text_to_text:   /^(nomic|gpt|davinci|curie|babbage|ada|claude|gemini|palm|command|generate|j2-|mistral|codestral)/i,
-    speech_to_text: /^whisper/i,
-    text_to_speech: /^tts/i,
-    text_to_image:  /^dall-e/i
-  }
-
-  class << self
+  # TODO: Use system environment varibles
+  #       AI_CLIENT_CONFIG_FILE
+  #
+  # TODO: Config.load('path/to/some_file.yml')
+  #         @@default_config (on require from lib/config.yml)
+  #         @@config (if the envar exists ?? merge with default)
+  #         @config ... done
 
-    def configure
-      yield(configuration)
-    end
+  class Config < Hashie::Mash
+    include Hashie::Extensions::Mash::PermissiveRespondTo
+    include Hashie::Extensions::Mash::SymbolizeKeys
+    include Hashie::Extensions::Mash::DefineAccessors
+  
 
-    def configuration
-      @configuration ||= Configuration.new
-    end
+    # I'm not sure about this ...
+    # def provider(name, &block)
+    #   if block_given?
+    #     providers[name] = block.call
+    #   else
+    #     providers[name] || {}
+    #   end
+    # end
 
   end
 
 
+  # Class variables to hold default and current config
+  @@default_config = Config.new(
+    logger: Logger.new(STDOUT),
+    timeout: nil,
+    return_raw: false,
+    providers: {},
+    provider_patterns: {
+      anthropic: /^claude/i,
+      openai: /^(gpt|davinci|curie|babbage|ada|whisper|tts|dall-e)/i,
+      google: /^(gemini|palm)/i,
+      mistral: /^(mistral|codestral)/i,
+      localai: /^local-/i,
+      ollama: /(llama|nomic)/i
+    },
+    model_types: {
+      text_to_text: /^(nomic|gpt|davinci|curie|babbage|ada|claude|gemini|palm|command|generate|j2-|mistral|codestral)/i,
+      speech_to_text: /^whisper/i,
+      text_to_speech: /^tts/i,
+      text_to_image: /^dall-e/i
+    }
+  )
 
+  @@class_config = @@default_config.dup
 
-  # Usage example:
-  # Configure general settings
-  #   AiClient.configure do |config|
-  #     config.logger = Logger.new('ai_client.log')
-  #     config.return_raw = true
-  #   end
-  #
-  # Configure provider-specific settings
-  #   AiClient.configure do |config|
-  #     config.configure_provider(:openai) do
-  #       {
-  #         organization: 'org-123',
-  #         api_version: 'v1'
-  #       }
-  #     end
-  #   end
-  #
-
-  class Configuration
-    attr_accessor :logger, :timeout, :return_raw
-    attr_reader :providers, :provider_patterns, :model_types
+  class << self
+    def configure(&block)
+      yield(class_config)
+    end
 
-    def initialize
-      @logger             = Logger.new(STDOUT)
-      @timeout            = nil
-      @return_raw         = false
-      @providers          = {}
-      @provider_patterns  = AiClient::PROVIDER_PATTERNS.dup
-      @model_types        = AiClient::MODEL_TYPES.dup
+    def class_config
+      @@class_config
+    end
+    
+    def class_config=(value)
+      @@class_config = value
     end
 
-    def provider(name, &block)
-      if block_given?
-        @providers[name] = block
-      else
-        @providers[name]&.call || {}
-      end
+    def default_config
+      @@default_config
     end
   end
-end
+end

data/lib/ai_client/middleware.rb

@@ -0,0 +1,37 @@
+# lib/ai_client/middleware.rb
+
+# TODO: As concurrently designed the middleware must
+#       be set before an instance of AiClient is created.
+#       Any `use` commands for middleware made after
+#       the instance is created will not be available
+#       to that instance.
+#       Change this so that middleware can be added
+#       and removed from an existing client.
+
+
+class AiClient
+
+  def call_with_middlewares(method, *args, **kwargs, &block)
+    stack = self.class.middlewares.reverse.reduce(-> { send(method, *args, **kwargs, &block) }) do |next_middleware, middleware|
+      -> { middleware.call(self, next_middleware, *args, **kwargs) }
+    end
+    stack.call
+  end
+
+
+  class << self
+
+    def middlewares
+      @middlewares ||= []
+    end
+
+    def use(middleware)
+      middlewares << middleware
+    end
+
+    def clear_middlewares
+      @middlewares = []
+    end
+  end
+
+end

data/lib/ai_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class AiClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ai_client.rb

@@ -17,6 +17,7 @@ require_relative 'extensions/omniai-ollama'
 require_relative 'extensions/omniai-localai'
 
 require_relative 'ai_client/configuration'
+require_relative 'ai_client/middleware'
 require_relative 'ai_client/version'
 
 # Create a generic client instance using only model name
@@ -26,25 +27,53 @@ require_relative 'ai_client/version'
 #   AiClient.use(RetryMiddleware.new(max_retries: 5, base_delay: 2, max_delay: 30))
 #   AiClient.use(LoggingMiddleware.new(AiClient.configuration.logger))
 #
-# TODO: As concurrently designed the middleware must
-#       be set before an instance of AiClient is created.
-#       Any `use` commands for middleware made after
-#       the instance is created will not be available
-#       to that instance.
-#       Change this so that middleware can be added
-#       and removed from an existing client.
+
 
 class AiClient
 
-  attr_reader :client, :provider, :model, :model_type, :logger, :last_response, :config
+  attr_reader :client,        # OmniAI's client instance
+              :provider,      # [Symbol]
+              :model,         # [String]
+              :model_type,    # [Symbol]
+              :logger, 
+              :last_response,
+              :timeout,
+              :config         # Instance configuration
+
+  # You can over-ride the class config by providing a block like this
+  #   c = AiClient.new(...) do |config|
+  #         config.logger = nil
+  #       end
+  #
+  # You can also load an instance's config from a YAML file.
+  #   c = AiClient.new('model_name'. cpmfog: 'path/to/file.yml', ...)
+  #
+  # ... and you can do both = load from a file and
+  #     over-ride with a config block
+  #
+  # The options object is basically those things that the
+  # OmniAI clients want to see.
+  #
+  def initialize(model, **options, &block)
+    # Assign the instance variable @config from the class variable @@config
+    @config = self.class.class_config.dup  
+    
+    # Yield the @config to a block if given
+    yield(@config) if block_given?
+
+    # Merge in an instance-specific YAML file
+    if options.has_key?(:config)
+      @config.merge! Config.load(options[:config])
+      options.delete(:config) # Lconfig not supported by OmniAI
+    end
+
+    @model            = model
+    explicit_provider = options.fetch(:provider, config.provider)
 
-  def initialize(model, config: Configuration.new, **options)
-    @model      = model
-    @config     = config
-    @provider   = validate_provider(options[:provider]) || determine_provider(model)
+    @provider   = validate_provider(explicit_provider) || determine_provider(model)
     @model_type = determine_model_type(model)
 
-    provider_config = @config.provider(@provider)
+    provider_config = @config.providers[@provider] || {}
 
     @logger   = options[:logger]    || @config.logger
     @timeout  = options[:timeout]   || @config.timeout
@@ -58,6 +87,7 @@ class AiClient
   end
 
 
+
   def response  = last_response
   def raw?      = config.return_raw
   
@@ -71,7 +101,6 @@ class AiClient
   def chat(messages, **params)
     result = call_with_middlewares(:chat_without_middlewares, messages, **params)
     @last_response = result
-    # debug_me print " (raw: #{raw?}) "
     raw? ? result : content
   end
 
@@ -114,14 +143,6 @@ class AiClient
   ######################################
   ## Utilities
   
-  def call_with_middlewares(method, *args, **kwargs, &block)
-    stack = self.class.middlewares.reverse.reduce(-> { send(method, *args, **kwargs, &block) }) do |next_middleware, middleware|
-      -> { middleware.call(self, next_middleware, *args, **kwargs) }
-    end
-    stack.call
-  end
-
-
   def content
     case @provider
     when :openai, :localai, :ollama
@@ -141,21 +162,6 @@ class AiClient
   ##############################################
   ## Public Class Methods
 
-  class << self
-
-    def middlewares
-      @middlewares ||= []
-    end
-
-    def use(middleware)
-      middlewares << middleware
-    end
-
-    def clear_middlewares
-      @middlewares = []
-    end
-  end
-
   def method_missing(method_name, *args, &block)
     if @client.respond_to?(method_name)
       result = @client.send(method_name, *args, &block)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ai_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-03 00:00:00.000000000 Z
+date: 2024-10-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: omniai
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +155,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".envrc"
+- ".irbrc"
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -154,6 +169,7 @@ files:
 - lib/ai_client.rb
 - lib/ai_client/configuration.rb
 - lib/ai_client/logger_middleware.rb
+- lib/ai_client/middleware.rb
 - lib/ai_client/retry_middleware.rb
 - lib/ai_client/version.rb
 - lib/extensions/omniai-localai.rb