ai_client 0.3.0 → 0.4.0

data/lib/ai_client/open_router_extensions.rb

@@ -1,60 +1,76 @@
 # lib/ai_client/open_router_extensions.rb
-# frozen_string_literal: true
 
-# These extensions to AiClient are only available with
-# a valid API Key for the open_router.ai web-service
+# OpenRouter Extensions for AiClient
+#
+# This file adds several public instance and class methods to the AiClient class
+# to provide information about AI models and providers.
+#
+# Instance Methods:
+# - model_details: Retrieves details for the current model.
+# - models: Retrieves model names for the current provider.
+#
+# Class Methods:
+# - providers: Retrieves all available providers.
+# - models: Retrieves model names, optionally filtered by provider.
+# - model_details: Retrieves details for a specific model.
+#
+# These methods utilize the AiClient::LLM class and the models.yml file
+# for model information.
 
 require 'open_router'
 require 'yaml'
 
 class AiClient
-  
-  # Retrieves the available models.
-  #
-  # @return [Array<String>] List of model IDs.
-  #
-  def models
-    self.class.models
-  end
 
-  # Retrieves the available providers.
+  # Retrieves details for the current model.
   #
-  # @return [Array<String>] List of provider names.
-  def providers
-    self.class.providers
+  # @return [Hash, nil] Details of the current model or nil if not found.
+  def model_details
+    id = "#{@provider}/#{@model}"
+    LLM.find(id.downcase)
   end
 
-  # Retrieves model names, optionally filtered by provider.
+  # Retrieves model names for the current provider.
   #
-  # @param provider [String, nil] The provider to filter models by.
-  # @return [Array<String>] List of model names.
-  def model_names(provider = nil)
-    self.class.model_names(provider)
-  end
+  # @return [Array<String>] List of model names for the current provider.
+  def models = LLM.models(@provider)
 
-  # Retrieves details for a specific model.
-  #
-  # @param a_model [String] The model ID to retrieve details for.
-  # @return [Hash, nil] Details of the model or nil if not found.
-  def model_details(a_model)
-    self.class.model_details(a_model)
-  end
 
-  # Finds models matching a given substring.
-  #
-  # @param a_model_substring [String] The substring to search for.
-  # @return [Array<String>] List of matching model names.
-  def find_model(a_model_substring)
-    self.class.find_model(a_model_substring)
-  end
+  class << self
+
+    # Retrieves all available providers.
+    #
+    # @return [Array<Symbol>] List of all provider names.
+    def providers = LLM.providers
 
 
-  class << self
-    
-    # Adds OpenRouter extensions to AiClient.
+    # Retrieves model names, optionally filtered by provider.
+    #
+    # @param substring [String, nil] Optional substring to filter models by.
+    # @return [Array<String>] List of model names.
+    def models(substring = nil) = LLM.models(substring)
+
+    # Retrieves details for a specific model.
+    #
+    # @param model_id [String] The model ID to retrieve details for,
+    #     in the pattern "provider/model".downcase
+    # @return [AiClient::LLM, nil] Details of the model or nil if not found.
+    def model_details(model_id) = LLM.find(model_id.downcase)
+
+
+    # Resets LLM data with the available ORC models.
     #
     # @return [void]
     #
+    def reset_llm_data = LLM.reset_llm_data
+
+
+    # Initializes OpenRouter extensions for AiClient.
+    #
+    # This sets up the access token and initializes the ORC client.
+    # 
+    # @return [void]
+    #
     def add_open_router_extensions
       access_token = fetch_access_token
 
@@ -64,7 +80,9 @@ class AiClient
       initialize_orc_client
     end
 
-    # Retrieves ORC client instance.
+
+
+    # Retrieves the ORC client instance.
     #
     # @return [OpenRouter::Client] Instance of the OpenRouter client.
     #
@@ -72,6 +90,10 @@ class AiClient
       @orc_client ||= add_open_router_extensions || raise("OpenRouter extensions are not available")
     end
 
+
+    private
+
+
     # Retrieves models from the ORC client.
     #
     # @return [Array<Hash>] List of models.
@@ -80,59 +102,7 @@ class AiClient
       @orc_models ||= orc_client.models
     end
 
-    # TODO: Refactor these DB like methods to take
-    #       advantage of AiClient::LLM
 
-    # Retrieves model names associated with a provider.
-    #
-    # @param provider [String, nil] The provider to filter models by.
-    # @return [Array<String>] List of model names.
-    #
-    def model_names(provider=nil)
-      model_ids = models.map { _1['id'] }
-
-      return model_ids unless provider
-
-      model_ids.filter_map { _1.split('/')[1] if _1.start_with?(provider.to_s.downcase) }
-    end
-
-    # Retrieves details of a specific model.
-    #
-    # @param model [String] The model ID to retrieve details for.
-    # @return [Hash, nil] Details of the model or nil if not found.
-    #
-    def model_details(model)
-      orc_models.find { _1['id'].include?(model) }
-    end
-
-    # Retrieves the available providers.
-    #
-    # @return [Array<String>] List of unique provider names.
-    #
-    def providers
-      @providers ||= models.map{ _1['id'].split('/')[0] }.sort.uniq      
-    end
-
-    # Finds models matching a given substring.
-    #
-    # @param a_model_substring [String] The substring to search for.
-    # @return [Array<String>] List of matching model names.
-    #
-    def find_model(a_model_substring)
-      model_names.select{ _1.include?(a_model_substring) }
-    end
-  
-    # Resets LLM data with the available ORC models.
-    #
-    # @return [void]
-    #
-    def reset_llm_data
-      LLM.data = orc_models
-      LLM::DATA_PATH.write(orc_models.to_yaml)
-    end
-
-
-    private
 
     # Fetches the access token from environment variables.
     #
@@ -154,10 +124,9 @@ class AiClient
       OpenRouter.configure { |config| config.access_token = access_token }
     end
 
-    # Initializes the ORC client.
-    #
-    # @return [void]
+    # Initializes the ORC client instance.
     #
+    # @return [OpenRouter::Client] Instance of the OpenRouter client.
     def initialize_orc_client
       @orc_client ||= OpenRouter::Client.new
     end

data/lib/ai_client/tool.rb

@@ -1,14 +1,11 @@
 # lib/ai_client/tool.rb
 
-# TODO: Turn this into a Function class using the pattern
-#       in examples/tools.rb
-#       put the function names as symbols into a class Array
-#       In the AiClient class transform the tools: []
-#       parameter from an Array of Symbols into an Array
-#       of FUnction instances.
-
 class AiClient::Tool < OmniAI::Tool
   
+  # TODO: Is there any additional functionality that
+  #       needs to be added to the Rool class that would
+  #       be helpful?
+  
   def xyzzy = self.class.xyzzy
 
   class << self

data/lib/ai_client/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 class AiClient
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
+
+  def version       = VERSION
+  def self.version  = VERSION
 end

data/lib/ai_client.rb

@@ -1,6 +1,17 @@
 # ai_client.rb
-# WIP:  a generic client to access LLM providers
-#       kinda like the SaaS "open router"
+
+# A generic client to access various LLM providers
+# Inspired by the SaaS "open router" concept
+
+
+# AiClient: A unified interface for interacting with various LLM providers
+#
+# Usage:
+#   client = AiClient.new('gpt-3.5-turbo')
+#
+# Add middlewares:
+#   AiClient.use(RetryMiddleware.new(max_retries: 5, base_delay: 2, max_delay: 30))
+#   AiClient.use(LoggingMiddleware.new(AiClient.configuration.logger))
 #
 
 unless defined?(DebugMe)
@@ -74,10 +85,12 @@ class AiClient
   attr_reader :client,        # OmniAI's client instance
               :provider,      # [Symbol]
               :model,         # [String]
-              :logger, 
+              :logger,
+              :last_message,
               :last_response,
               :timeout,
-              :config         # Instance configuration
+              :config,        # Instance configuration
+              :context        # chat-bot context
 
   # Initializes a new AiClient instance.
   #
@@ -103,72 +116,54 @@ class AiClient
   #   - :timeout [Integer] Timeout value for requests.
   # @yield [config] An optional block to configure the instance.
   #
-  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)
-
-    @provider   = validate_provider(explicit_provider) || determine_provider(model)
-
-    provider_config = @config.providers[@provider] || {}
-
-    @logger   = options[:logger]    || @config.logger
-    @timeout  = options[:timeout]   || @config.timeout
-    @base_url = options[:base_url]  || provider_config[:base_url]
-    @options  = options.merge(provider_config)
+  def initialize(model = nil, **options, &block)
+    @context        = [] # An Array of String or response objects
+    @last_messages  = nil
+    @last_response  = nil
 
-    # @client is an instance of an OmniAI::* class
-    @client         = create_client
+    setup_config(options, &block)
+    set_provider_and_model(model, options[:provider])
+    setup_instance_variables(options)
 
-    @last_response  = nil
+    @client = create_client
   end
 
-  # TODO: Review these raw-ish methods are they really needed?
-  #       raw? should be a private method ??
-
-  # Returns the last response received from the client.
-  #
-  # @return [OmniAI::Response] The last response.
-  #
-  def response  = last_response
   
   # Checks if the client is set to return raw responses.
   #
   # @return [Boolean] True if raw responses are to be returned.
-  def raw?      = config.return_raw
-  
+  def raw?
+    config.return_raw
+  end
+
 
   # Sets whether to return raw responses.
   #
   # @param value [Boolean] The value to set for raw responses return.
-  #
   def raw=(value)
     config.return_raw = value
   end
 
+
+  # Returns the last response received from the client.
+  #
+  # @return [OmniAI::Response] The last response.
+  #
+  def response  = last_response
+
+
   # Extracts the content from the last response based on the provider.
   #
   # @return [String] The extracted content.
   # @raise [NotImplementedError] If content extraction is not implemented for the provider.
   #
-  def content
+  def content(response=last_response)
     case @provider
     when :localai, :mistral, :ollama, :open_router, :openai
-      last_response.data.tunnel 'content'
+      response.data.tunnel 'content'
       
     when :anthropic, :google
-      last_response.data.tunnel 'text'
+      response.data.tunnel 'text'
 
     else
       raise NotImplementedError, "Content extraction not implemented for provider: #{@provider}"
@@ -207,6 +202,47 @@ class AiClient
   ##############################################
   private
 
+  def setup_config(options, &block)
+    @config = self.class.class_config.dup  
+
+    yield(@config) if block_given?
+
+    if options.key?(:config)
+      @config.merge!(Config.load(options[:config]))
+      options.delete(:config) # config not supported by OmniAI
+    end
+  end
+
+
+  def set_provider_and_model(my_model, my_provider)
+    if my_model.nil?
+      if my_provider.nil?
+        @provider = @config.default_provider.to_sym
+      else
+        @provider = validate_provider(my_provider)
+      end
+      @model    = @config.default_model[@provider]
+    else
+      @model = my_model
+      if my_provider.nil?
+        @provider = determine_provider(my_model)
+      else
+        @provider = validate_provider(my_provider)
+      end
+    end
+  end
+
+
+  def setup_instance_variables(options)
+    provider_config = @config.providers[@provider] || {}
+
+    @logger   = options[:logger] || @config.logger
+    @timeout  = options[:timeout] || @config.timeout
+    @base_url = options[:base_url] || provider_config[:base_url]
+    @options  = options.merge(provider_config)
+  end
+
+
   # Validates the specified provider.
   #
   # @param provider [Symbol] The provider to validate.
@@ -284,9 +320,9 @@ class AiClient
   # @raise [ArgumentError] If the model is unsupported.
   #
   def determine_provider(model)
+    return nil if model.nil? || model.empty?
+
     config.provider_patterns.find { |provider, pattern| model.match?(pattern) }&.first ||
       raise(ArgumentError, "Unsupported model: #{model}")
   end
 end
-
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_hash
@@ -262,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A generic AI Client for many providers