ai_client 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4128ef9024e8bc84820346570886aa9b3e25a4e8e442556591d45e0900cf9ea
-  data.tar.gz: 64d339534320c27eb060b02ae927f39a829f3792319dc1cd71e3e0920d6aa0ed
+  metadata.gz: f2b330f59ff7f380306ec354ce5f7197adce8dd101a4b506ab137568f098242a
+  data.tar.gz: f169296b9f20479b1c608f2202d9ab8a8eb416aa80b07f4308ec4648b9c86fcc
 SHA512:
-  metadata.gz: ef72dd20224bd2f887686c1c75881e8bd9195c60ac2a416c9acee3a93cf09335b852381ce3bf314cab72e9b2a7136b4d2bf3f0f622f39f55f1555500796fca17
-  data.tar.gz: 33cc0e5fcf58ebadb5269138342f4e6c49d42604e2ee2fd22630764c1d288bfafdc3c7999467d2dfe890cd9daae573165f497bd1044d807f80d3a89e97f3de33
+  metadata.gz: ce0e2cddd8ec6935a5bea24125358fbcc8fda902340d7767972142505af41eaeef7d7f6f5791bd7d26469fd45e59020237fd0061e75d6a987d8a4181597cdbe9
+  data.tar.gz: 4b2513fba82802eda13cf26c1af0e73f0903a2140765401ed686540d80480d887f2152e342a5fe3546c89482320f61cc6bd04b4e41b8851668bbda31b2496fc9

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 ## [Unreleased]
 
 ## Released
+
+### [0.2.5] - 2024-10-11
+- Added examples/tool.rb to demonstrate use of function callbacks to provide information to the LLM when it needs it.
+
+### [0.2.4] - 2024-10-10
+- constrained gem omniai-openai to version 1.8.3+ for access to open_router.ai
+- caching models database from open_router.ai
+- added class methods reset_default_config and reset_llm_data
+- support for open_router.ai should be fully integrated now that omniai-openai is at version 1.8.3
+
+
 ### [0.2.3] - 2024-10-08
 - refactored the OmniAI extensions for Ollama, LocalAI and OpenRouter
 - added a file for OpenRouter extensions

data/README.md

@@ -284,8 +284,7 @@ One of the latest innovations in LLMs is the ability to use functions (aka tools
 
 See [blog post](https://ksylvest.com/posts/2024-08-16/using-omniai-to-leverage-tools-with-llms) by Kevin Sylvestre, author of the OmniAI gem.
 
-
-TODO: Need to create an example RAG that does not need another access token to a service
+Take a look at the [examples/tools.rb](examples/tools.rb) file to see different ways in which these callable processes can be defined.
 
 
 ## Best ?? Practices

data/examples/README.md

@@ -7,6 +7,7 @@
 | embed.rb | Demonstrates using Ollama locally to vectorize text for embeddings|
 | speak.rb | Demonstrates using OpenAI's text to speech models |
 | text.rb | Demonstrates text-to-text transformers "chat" |
+| tools.rb | Demonstrates usage of functional callbacks (i.e. tools) |
 | transcribe.rb | Uses OpenAI's audio-to-text model |
 
 Many of these example programs show both the raw response object as well as just the

data/examples/tools.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+# examples/tools.rb
+# See: https://ksylvest.com/posts/2024-08-16/using-omniai-to-leverage-tools-with-llms
+
+require_relative 'common'
+
+AI = AiClient.new('gpt-4o')
+
+box "omniai-openai's random temp example"
+
+my_weather_function = Proc.new do |location:, unit: 'Celsius'| 
+  "#{rand(20..50)}° #{unit} in #{location}"
+end
+
+weather = AiClient::Tool.new(
+  my_weather_function,
+  name: 'weather',
+  description: 'Lookup the weather in a location',
+  parameters: AiClient::Tool::Parameters.new(
+    properties: {
+      location: AiClient::Tool::Property.string(description: 'e.g. Toronto'),
+      unit: AiClient::Tool::Property.string(enum: %w[Celsius Fahrenheit]),
+    },
+    required: %i[location]
+  )
+)
+
+simple_prompt = <<~TEXT
+  What is the weather in "London" in Celsius and "Paris" in Fahrenheit?
+  Also what are some ideas for activities in both cities given the weather?
+TEXT
+
+response = AI.chat(simple_prompt, tools: [weather])
+puts response
+
+##########################################
+box "Accessing a database to get information"
+
+llm_db_function = Proc.new do |params|
+  records = AiClient::LLM.where(id: /#{params[:model_name]}/i)
+  records.inspect
+end
+
+
+llm_db = AiClient::Tool.new(
+  llm_db_function,
+  name: 'llm_db',
+  description: 'lookup details about an LLM model name',
+  parameters: AiClient::Tool::Parameters.new(
+    properties: {
+      model_name: AiClient::Tool::Property.string
+    },
+    required: %i[model_name]
+  )
+)
+
+response = AI.chat("Get details on an LLM model named bison.  Which one is the cheapest per prompt token.", tools: [llm_db])
+puts response
+
+##########################################
+
+# TODO: Look at creating a better function
+#       process such that the tools parameter
+#       is an Array of Symbols which is
+#       maintained as a class variable.
+#       The symboles are looked up and the
+#       proper instance is inserted in its
+#       place.
+
+box "Using a function class and multiple tools"
+
+class FunctionClass
+  def self.call
+    "April 25th its not to hot nor too cold."
+  end
+
+  def function(my_name)
+    AiClient::Tool.new(
+      self.class, # with a self.call method
+      name: my_name,
+      description: 'what is the perfect date'
+    )
+  end
+end
+
+perfect_date = FunctionClass.new.function('perfect_date')
+
+response = AI.chat("what is the perfect date for paris weather?", tools: [weather, perfect_date])
+puts response
+puts

data/lib/ai_client/config.yml

@@ -14,7 +14,7 @@
     binmode: false
     reraise_write_errors: []
     mon_data: !ruby/object:Monitor {}
-    mon_data_owner_object_id: 700
+    mon_data_owner_object_id: 45380
   level_override: {}
 :timeout:
 :return_raw: false

data/lib/ai_client/configuration.rb

@@ -92,7 +92,11 @@ class AiClient
     include Hashie::Extensions::Mash::SymbolizeKeys
     include Hashie::Extensions::Mash::DefineAccessors
 
-
+    # Saves the current configuration to the specified file.
+    #
+    # @param filepath [String] The path to the file where the configuration will be saved.
+    #   Defaults to '~/aiclient_config.yml' if not provided.
+    #
     def save(filepath=ENV['HOME']+'/aiclient_config.yml')
       filepath = Pathname.new(filepath) unless filepath.is_a? Pathname
 
@@ -101,6 +105,13 @@ class AiClient
 
 
     class << self
+      # Loads configuration from the specified YAML file.
+      #
+      # @param filepath [String] The path to the configuration file.
+      #   Defaults to 'config.yml' if not provided.
+      # @return [AiClient::Config] The loaded configuration.
+      # @raise [ArgumentError] If the specified file does not exist.
+      #
       def load(filepath=DEFAULT_CONFIG_FILEPATH)
         filepath = Pathname.new(filepath) unless Pathname == filepath.class
         if filepath.exist?
@@ -115,12 +126,30 @@ class AiClient
   class << self
     attr_accessor :class_config, :default_config
 
+    # Configures the AiClient with a given block.
+    #
+    # @yieldparam config [AiClient::Config] The configuration instance.
+    # @return [void]
+    #
     def configure(&block)
       yield(class_config)
     end
 
-    private
+    # Resets the default configuration to the value defined in the class.
+    #
+    # @return [void]
+    #
+    def reset_default_config
+      initialize_defaults
+        .save(Config::DEFAULT_CONFIG_FILEPATH)      
+    end
 
+    private
+    
+    # Initializes the default configuration.
+    #
+    # @return [void]
+    #
     def initialize_defaults
       @default_config = Config.new(
         logger: Logger.new(STDOUT),

data/lib/ai_client/llm.rb

@@ -1,26 +1,38 @@
 # lib/ai_client/llm.rb
 
 require 'active_hash'
+require 'yaml'
 
-class AiClient
-
-  # TODO: Think about this for the OpenRouter modesl DB
-  #       Might cahnge this to ActiveYaml
 
+class AiClient
   class LLM < ActiveHash::Base
-    self.data = AiClient.models
+    DATA_PATH = Pathname.new( __dir__ + '/models.yml')
+    self.data = YAML.parse(DATA_PATH.read).to_ruby 
 
+    # Extracts the model name from the LLM ID.
+    #
+    # @return [String] the model name.
+    #
     def model     = id.split('/')[1]
-    def provider  = id.split('/')[0]
 
-    class << self
-      def import(path_to_uml_file) # TODO: load
-        raise "TODO: Not Implemented: #{path_to_yml_file}"
-      end
+    # Extracts the provider name from the LLM ID.
+    #
+    # @return [String] the provider name.
+    #
+    def provider  = id.split('/')[0]
+  end
 
-      def export(path_to_uml_file) # TODO: Dump
-        raise "TODO: Not Implemented: #{path_to_yml_file}"
-      end
+  class << self
+    
+    # Resets the LLM data by fetching models from the Orc client
+    # and writing it to the models.yml file.
+    #
+    # @return [void] 
+    #
+    def reset_llm_data
+      orc_models = AiClient.orc_client.models
+      AiClient::LLM.data = orc_models
+      AiClient::LLM::DATA_PATH.write(orc_models.to_yaml)
     end
   end
 end

data/lib/ai_client/logger_middleware.rb

@@ -16,10 +16,23 @@ class AiClient
   # )
 
   class LoggingMiddleware
+    
+    # Initializes the LoggingMiddleware with a logger.
+    #
+    # @param logger [Logger] The logger used for logging middleware actions.
+    #
     def initialize(logger)
       @logger = logger
     end
 
+    # Calls the next middleware in the stack while logging the start and finish times.
+    #
+    # @param client [Object] The client instance.
+    # @param next_middleware [Proc] The next middleware to call.
+    # @param args [Array] The arguments passed to the middleware call, with the first being the method name.
+    #
+    # @return [Object] The result of the next middleware call.
+    #
     def call(client, next_middleware, *args)
       method_name = args.first.is_a?(Symbol) ? args.first : 'unknown method'
       @logger.info("Starting #{method_name} call")

data/lib/ai_client/middleware.rb

@@ -8,9 +8,19 @@
 #       Change this so that middleware can be added
 #       and removed from an existing client.
 
-
+# AiClient class that handles middleware functionality
+# for API calls.
 class AiClient
 
+  # Calls the specified method with middlewares applied.
+  #
+  # @param method [Symbol] the name of the method to be called
+  # @param args [Array] additional arguments for the method
+  # @param kwargs [Hash] named parameters for the method
+  # @param block [Proc] optional block to be passed to the method
+  #
+  # @return [Object] result of the method call after applying middlewares
+  #
   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) }
@@ -21,17 +31,30 @@ class AiClient
 
   class << self
 
+    # Returns the list of middlewares applied to the client.
+    #
+    # @return [Array] list of middlewares
+    #
     def middlewares
       @middlewares ||= []
     end
 
+    # Adds a middleware to the stack.
+    #
+    # @param middleware [Proc] the middleware to be added
+    #
+    # @return [void]
+    #
     def use(middleware)
       middlewares << middleware
     end
 
+    # Clears all middlewares from the client.
+    #
+    # @return [void]
+    #
     def clear_middlewares
       @middlewares = []
     end
   end
-
 end