ai_client 0.2.2 → 0.2.4

data/lib/ai_client/open_router_extensions.rb

@@ -0,0 +1,86 @@
+# 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
+
+require 'open_router'
+require 'yaml'
+
+class AiClient
+
+  def models                        = self.class.models
+  def providers                     = self.class.providers
+  def model_names(a_provider=nil)   = self.class.model_names(a_provider)
+  def model_details(a_model)        = self.class.model_details(a_model)
+  def find_model(a_model_substring) = self.class.find_model(a_model_substring)
+
+  class << self
+    def add_open_router_extensions
+      access_token = fetch_access_token
+
+      return unless access_token
+
+      configure_open_router(access_token)
+      initialize_orc_client
+    end
+
+    def orc_client
+      @orc_client ||= add_open_router_extensions || raise("OpenRouter extensions are not available")
+    end
+
+    def orc_models
+      @orc_models ||= orc_client.models
+    end
+
+    # TODO: Refactor these DB like methods to take
+    #       advantage of AiClient::LLM
+
+    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
+
+    def model_details(model)
+      orc_models.find { _1['id'].include?(model) }
+    end
+
+    def providers
+      @providers ||= models.map{ _1['id'].split('/')[0] }.sort.uniq      
+    end
+
+    def find_model(a_model_substring)
+      model_names.select{ _1.include?(a_model_substring) }
+    end
+  
+    def reset_llm_data
+      LLM.data = orc_models
+      LLM::DATA_PATH.write(orc_models.to_yaml)
+    end
+
+
+    private
+
+    # Similar to fetch_api_key but for the class_config
+    def fetch_access_token
+      class_config.envar_api_key_names.open_router
+                  .map { |key| ENV[key] }
+                  .compact
+                  .first
+    end
+    
+    def configure_open_router(access_token)
+      OpenRouter.configure { |config| config.access_token = access_token }
+    end
+
+    def initialize_orc_client
+      @orc_client ||= OpenRouter::Client.new
+    end
+  end
+end
+
+
+AiClient.add_open_router_extensions

data/lib/ai_client/version.rb

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

data/lib/ai_client.rb

@@ -16,10 +16,6 @@ require 'omniai/openai'
 
 require 'open_router'
 
-require_relative 'extensions/omniai-localai'
-require_relative 'extensions/omniai-ollama'
-require_relative 'extensions/omniai-open_router'
-
 require_relative 'ai_client/chat'
 require_relative 'ai_client/embed'
 require_relative 'ai_client/speak'
@@ -29,6 +25,9 @@ require_relative 'ai_client/configuration'
 require_relative 'ai_client/middleware'
 require_relative 'ai_client/version'
 
+require_relative 'ai_client/open_router_extensions'
+require_relative 'ai_client/llm' # SMELL: must come after the open router stuff
+
 # Create a generic client instance using only model name
 #   client = AiClient.new('gpt-3.5-turbo')
 #
@@ -131,25 +130,12 @@ class AiClient
 
   def content
     case @provider
-    when :openai, :localai, :ollama
-      # last_response.data.dig('choices', 0, 'message', 'content')
+    when :localai, :mistral, :ollama, :open_router, :openai
       last_response.data.tunnel 'content'
       
-    when :anthropic
-      # last_response.data.dig('content',0,'text')
+    when :anthropic, :google
       last_response.data.tunnel 'text'
 
-    when :google
-      # last_response.data.dig('candidates', 0, 'content', 'parts', 0, 'text')
-      last_response.data.tunnel 'text'
-
-    when :mistral
-      # last_response.data.dig('choices', 0, 'message', 'content')
-      last_response.data.tunnel 'content'
-
-    when :open_router
-      last_response.data.tunnel 'content'
-
     else
       raise NotImplementedError, "Content extraction not implemented for provider: #{@provider}"
     end
@@ -187,9 +173,8 @@ class AiClient
 
 
   def create_client
-    api_key = fetch_api_key  # Fetching the API key should only happen for valid providers
     client_options = {
-      api_key:  api_key,
+      api_key:  fetch_api_key,
       logger:   @logger,
       timeout:  @timeout
     }
@@ -210,13 +195,13 @@ class AiClient
       OmniAI::Mistral::Client.new(**client_options)
 
     when :ollama
-      OmniAI::Ollama::Client.new(**client_options)
+      OmniAI::OpenAI::Client.new(host: 'http://localhost:11434', api_key: nil, **client_options)
 
     when :localai
-      OmniAI::LocalAI::Client.new(**client_options)
+      OmniAI::OpenAI::Client.new(host: 'http://localhost:8080', api_key: nil, **client_options)
 
     when :open_router
-      OmniAI::OpenRouter::Client.new(**client_options)
+      OmniAI::OpenAI::Client.new(host: 'https://openrouter.ai', api_prefix: 'api', **client_options)
 
     else
       raise ArgumentError, "Unsupported provider: #{@provider}"
@@ -224,20 +209,14 @@ class AiClient
   end
 
 
+  # Similar to fetch_access_tokne but for the instance config
   def fetch_api_key
-    env_var_name = "#{@provider.upcase}_API_KEY"
-    api_key = ENV[env_var_name]
-
-    if api_key.nil? || api_key.empty?
-      unless [:localai, :ollama].include? provider
-        raise ArgumentError, "API key not found in environment variable #{env_var_name}"
-      end
-    end
-
-    api_key
+    config.envar_api_key_names[@provider]
+      &.map { |key| ENV[key] }
+      &.compact
+      &.first
   end
 
-
   def determine_provider(model)
     config.provider_patterns.find { |provider, pattern| model.match?(pattern) }&.first ||
       raise(ArgumentError, "Unsupported model: #{model}")

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ai_client
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_hash
+  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: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
   name: open_router
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tocer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "`ai_client` is a versatile Ruby gem that offers a seamless interface
   \nfor integrating a wide range of AI service providers through a single, \nunified
   API. With `ai_client`, you can simply specify the model name \nand quickly leverage
@@ -197,16 +225,15 @@ files:
 - lib/ai_client/config.yml
 - lib/ai_client/configuration.rb
 - lib/ai_client/embed.rb
+- lib/ai_client/llm.rb
 - lib/ai_client/logger_middleware.rb
 - lib/ai_client/middleware.rb
+- lib/ai_client/models.yml
+- lib/ai_client/open_router_extensions.rb
 - lib/ai_client/retry_middleware.rb
 - lib/ai_client/speak.rb
 - lib/ai_client/transcribe.rb
 - lib/ai_client/version.rb
-- lib/extensions/omniai-localai.rb
-- lib/extensions/omniai-ollama.rb
-- lib/extensions/omniai-open_router.rb
-- lib/extensions/open_router.md
 - sig/ai_client.rbs
 - the_ollama_model_problem.md
 homepage: https://github.com/MadBomber/ai_client

data/lib/extensions/omniai-localai.rb

@@ -1,31 +0,0 @@
-# extensions/omniai-localai.rb
-# frozen_string_literal: true
-
-require 'omniai'
-require 'omniai/openai'
-
-module OmniAI
-
-  # Create an alias for OmniAI::OpenAI module
-  module LocalAI
-    extend OmniAI::OpenAI
-
-    # Alias classes from OmniAI::OpenAI
-    class Client < OmniAI::OpenAI::Client
-      def initialize(**options)
-        options[:host] = 'http://localhost:8080' unless options.has_key?(:host)
-        super(**options)
-      end
-    end
-
-
-    Config = OmniAI::OpenAI::Config
-
-    # Alias the Thread class and its nested classes
-    Thread      = OmniAI::OpenAI::Thread
-    Annotation  = OmniAI::OpenAI::Thread::Annotation
-    Attachment  = OmniAI::OpenAI::Thread::Attachment
-    Message     = OmniAI::OpenAI::Thread::Message
-    Run         = OmniAI::OpenAI::Thread::Run
-  end
-end

data/lib/extensions/omniai-ollama.rb

@@ -1,30 +0,0 @@
-# extensions/omniai-ollama.rb
-# frozen_string_literal: true
-
-require 'omniai'
-require 'omniai/openai'
-
-module OmniAI
-
-  # Create an alias for OmniAI::OpenAI module
-  module Ollama
-    extend OmniAI::OpenAI
-
-    # Alias classes from OmniAI::OpenAI
-    class Client < OmniAI::OpenAI::Client
-      def initialize(**options)
-        options[:host] = 'http://localhost:11434' unless options.has_key?(:host)
-        super(**options)
-      end
-    end    
-
-    Config = OmniAI::OpenAI::Config
-
-    # Alias the Thread class and its nested classes
-    Thread      = OmniAI::OpenAI::Thread
-    Annotation  = OmniAI::OpenAI::Thread::Annotation
-    Attachment  = OmniAI::OpenAI::Thread::Attachment
-    Message     = OmniAI::OpenAI::Thread::Message
-    Run         = OmniAI::OpenAI::Thread::Run
-  end
-end

data/lib/extensions/omniai-open_router.rb

@@ -1,92 +0,0 @@
-# lib/extensions/omniai-open_router.rb
-# frozen_string_literal: true
-
-require 'omniai'
-require 'omniai/openai'
-
-module OmniAI
-
-  # Create an alias for OmniAI::OpenAI module
-  module OpenRouter
-    extend OmniAI::OpenAI
-
-    # Alias classes from OmniAI::OpenAI
-    class Client < OmniAI::OpenAI::Client
-      def initialize(**options)
-        options[:host] = 'https://openrouter.ai/api/v1' unless options.has_key?(:host)
-        super(**options)
-      end
-
-      def self.openrouter
-        OmniAI::OpenRouter::Client
-      end
-
-      def self.open_router
-        OmniAI::OpenRouter::Client
-      end
-
-      def self.find(provider:, **)
-        return OmniAI.open_router.new(**) if :open_reouter == provider
-
-        super(provider: provider.to_s, **)
-      end
-    end    
-
-    Chat = OmniAI::OpenAI::Chat
-
-    class Chat
-      def path
-        "/api/v1/chat/completions"
-      end
-    end
-
-    Config = OmniAI::OpenAI::Config
-
-    # Alias the Thread class and its nested classes
-    Thread              = OmniAI::OpenAI::Thread
-    Thread::Annotation  = OmniAI::OpenAI::Thread::Annotation
-    Thread::Attachment  = OmniAI::OpenAI::Thread::Attachment
-    Thread::Message     = OmniAI::OpenAI::Thread::Message
-    Thread::Run         = OmniAI::OpenAI::Thread::Run
-  end
-end
-
-######################################################
-## Extend Capabilities Using OpenRouter
-#
-# TODO: catch the models db
-# TODO: consider wrapping the models database in an ActiveModel
-#
-class AiClient
-  class << self
-    def orc_models
-      @orc_models ||= ORC.models if defined?(ORC)
-    end
-
-    def orc_model_names(provider=nil)
-      if provider.nil?
-        orc_models.map{|e| e['id']}
-      else
-        orc_models
-          .map{|e| e['id']}
-          .select{|name| name.start_with? provider.to_s.downcase}
-          .map{|e| e.split('/')[1]}
-      end
-    end
-
-    def orc_model_details(model)
-      orc_models.select{|e| e['id'].include?(model)}
-    end
-  end
-end
-
-if ENV.fetch('OPEN_ROUTER_API_KEY', nil)
-  OpenRouter.configure do |config|
-    config.access_token = ENV.fetch('OPEN_ROUTER_API_KEY', nil)
-  end
-
-  # Use a default provider/model
-  AiClient::ORC = OpenRouter::Client.new
-end
-
-

data/lib/extensions/open_router.md

@@ -1,97 +0,0 @@
-# Notes on OpenRouter
-
-OpenROuter is a web service that has a common API to many
-back-end LLM processors.  Its goal is basically the same as the
-OmniAI gem - provide the flexibility of using multiple models
-processed by myltiple providers.
-
-```ruby
-OpenRouter.configure do |config|
-  config.access_token = ENV.fetch('OPEN_ROUTER_API_KEY', nil)
-end
-
-# Use a default provider/model
-AI = OpenRouter::Client.new
-
-# Returns an Array of Hash for supported 
-# models/providers
-Models = AI.models
-```
-
-models with a "/" are targeted to open router.
-  before the "/" is the provider after it is the model name
-
-Will need to add this entriy to the AiClient::Config `provider_patterns` Hash:
-
-```ruby
-open_router: /\//,  # /(.*)\/(.*)/  provider / model name
-```
-
-models can be an Array of Strings.  The first is the primary while
-the rest are fallbacks in case there is one before fails
-
-```ruby
-{
-  "models": ["anthropic/claude-2.1", "gryphe/mythomax-l2-13b"],
-  "route": "fallback",
-  ... // Other params
-}
-```
-
-You can have OpenRouter send your prompt to the best
-provider/model for the prompt like this:
-
-```ruby
-require "open_router"
-
-OpenRouter.configure do |config|
-  config.access_token = ENV["ACCESS_TOKEN"]
-  config.site_name = "YOUR_APP_NAME"
-  config.site_url = "YOUR_SITE_URL"
-end
-
-OpenRouter::Client.new.complete(
-  model: "openrouter/auto",
-  messages: [
-    {
-      "role": "user",
-      "content": "What is the meaning of life?"
-    }
-  ]
-).then do |response|
-  puts response.dig("choices", 0, "message", "content")
-end
-```
-
-OpenRouter can also support OpenAI's API by using this
-  base_url: "https://openrouter.ai/api/v1",
-
-Request Format Documentation
-  https://openrouter.ai/docs/requests
-
-Simple Quick Start ...
-
-```ruby
-OpenRouter::Client.new.complete(
-  model: "openai/gpt-3.5-turbo",
-  messages: [
-    {
-      "role": "user",
-      "content": "What is the meaning of life?"
-    }
-  ]
-).then do |response|
-  puts response.dig("choices", 0, "message", "content")
-end
-```
-
-## Design Approaches
-
-There are at least two different approaches to
-integrate the OpenRouter capability.  1) Use the open_router gem
-and forget about using the same common-ish
-API established by OmniAI; or 2) Take advantage
-or OpenRouter's OpenAI's API and do for it
-the same thing that was done of Ollama and LocalAI.
-
-