ai_client 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07a66886ce84dd916574f7a38e292626124ed1a048da92eec33cfdc0e66435e4
-  data.tar.gz: dc9c6734ae4a6a479ed8f6b76fc8edea31dbb588f67ae801b915a067346c5735
+  metadata.gz: 7b12150b0f3f29804d520aa319a99cc71adc96f023ec99bccc0a9a6682bdba6e
+  data.tar.gz: 59d811a6b9de974f76672a9a1386d6efd3e4547d53ae7b4d24c532a250c00c86
 SHA512:
-  metadata.gz: ced4f6a3834132d0c1d127ad3fcd931e9600d748a28d6593fc9e382fb6bb98b9fd31de56d44d5a216c5f0bb8394c360f04779995fd2345ae1043e137cd994091
-  data.tar.gz: be77228ac195d1f3de41f1ec0e82f2d2e2aa0f280e51354156c00b9c40bdb466581c87b4ba73b22c57fa86300df9555b7a2230854ac6ff93e365028b946275ba
+  metadata.gz: 0beacebae38d5c2101498a59245c5112469ff8fddda2723b5d916ae6d5f731fa6e9e55de46422a6daf463242356e1575c0bbdf77612f9edf9fd05d6b4f885407
+  data.tar.gz: 36b2b5f5fd3d51577b31ac8cbcd57980cb7d0a912428f37e8f345764620aa02198a65b905505136ea40ea2866e274b1f8d6b9b1c9390ccd3608eaad138c37ebb

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 ## [Unreleased]
 
 ## Released
+### [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
+- Added the LLM class
+
 ### [0.2.2] - 2024-10-07
 - Added support for open_router.ai with extensions/omniai-open_router.rb
 - Removed the `model_type` object

data/README.md

@@ -4,32 +4,55 @@ First and foremost a big **THANK YOU** to [Kevin Sylvestre](https://ksylvest.com
 
 See the  [change log](CHANGELOG.md) for recent modifications.
 
-## Summary
 
-Are you ready to supercharge your applications with cutting-edge AI capabilities? 
-Introducing `ai_client`, the ultimate Ruby gem that provides a seamless interface 
-for interacting with a multitude of AI service providers through a single, 
-unified API. 
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [Summary](#summary)
+  - [Installation](#installation)
+  - [Environment Variables for Provider Access](#environment-variables-for-provider-access)
+    - [Changing Envar API Key Names](#changing-envar-api-key-names)
+    - [api_key: Parameter](#api_key-parameter)
+    - [provider: Parameter](#provider-parameter)
+  - [Usage](#usage)
+    - [Configuration](#configuration)
+      - [Default Configuration](#default-configuration)
+      - [Class Configuration](#class-configuration)
+        - [1. Class Configuration Block](#1-class-configuration-block)
+        - [2. Set by a Config File](#2-set-by-a-config-file)
+        - [3. Supplemented by a Config File](#3-supplemented-by-a-config-file)
+      - [Instance Configuration](#instance-configuration)
+        - [1. Supplement from a Constructor Block](#1-supplement-from-a-constructor-block)
+        - [2. Supplement from a YAML File](#2-supplement-from-a-yaml-file)
+        - [3. Load Complete Configuration from a YAML File](#3-load-complete-configuration-from-a-yaml-file)
+    - [Top-level Client Methods](#top-level-client-methods)
+        - [chat](#chat)
+        - [embed](#embed)
+        - [speak](#speak)
+        - [transcribe](#transcribe)
+    - [Options](#options)
+    - [Advanced Prompts](#advanced-prompts)
+    - [Advanced Prompts with Tools](#advanced-prompts-with-tools)
+  - [Best ?? Practices](#best--practices)
+  - [OmniAI and OpenRouter](#omniai-and-openrouter)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+
+## Summary
 
-With `ai_client`, you can effortlessly integrate large language models (LLMs) 
-into your projects—simply specify the model name and let the gem handle the 
-rest! Say goodbye to tedious configuration and hello to rapid development.
+Are you ready to supercharge your applications with cutting-edge AI capabilities? Introducing `ai_client`, the ultimate Ruby gem that provides a seamless interface for interacting with a multitude of AI service providers through a single, unified API.
 
-This gem comes packed with built-in support for leading AI providers, including 
-OpenAI, Anthropic, Google, Mistral, LocalAI, and Ollama. Whether you need to 
-implement chatbots, transcription services, speech synthesis, or embeddings, 
-`ai_client` abstracts the complexities of API interactions, allowing you to focus 
-on what truly matters: building amazing applications.
+With `ai_client`, you can effortlessly integrate large language models (LLMs) into your projects—simply specify the model name and let the gem handle the rest! Say goodbye to tedious configuration and hello to rapid development.
 
-Plus, with its flexible middleware architecture, you can easily customize request 
-and response processing—implement logging, retry logic, and more with minimal effort. 
-And thanks to its seamless integration with the `OmniAI` framework, you can leverage 
-the latest AI advancements without worrying about vendor lock-in.
+This gem comes packed with built-in support for leading AI providers, including OpenAI, Anthropic, Google, Mistral, LocalAI, and Ollama. Whether you need to implement chatbots, transcription services, speech synthesis, or embeddings, `ai_client` abstracts the complexities of API interactions, allowing you to focus on what truly matters: building amazing applications.
 
-Join the growing community of developers who are transforming their applications 
-with `ai_client`. Install it today and unlock the full potential of AI in your 
-projects!
+Plus, with its flexible middleware architecture, you can easily customize request and response processing—implement logging, retry logic, and more with minimal effort. And thanks to its seamless integration with the `OmniAI` framework, you can leverage the latest AI advancements without worrying about vendor lock-in.
 
+Join the growing community of developers who are transforming their applications with `ai_client`. Install it today and unlock the full potential of AI in your projects!
 
 ## Installation
 
@@ -45,13 +68,9 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install ai_client
 ```
 
-## Providers Supported
+## Environment Variables for Provider Access
 
-To explicitely designate a provider to use with an AiClient instance
-use the parameter `provider: :your_provider` with the Symbol for the supported
-provider you want to use with the model you specify.  The following providers
-are supported by the OmniAI gem upon which AiClient depends along with a few
-extensions.
+For fee providers require an account and provide an access token to allow the use of their LLM models.  The value of these access tokens is typically saved in system environment variables or some other secure data store.  AiClient has a default set of system environment variable names for these access tokens based upon the pattern of `provider_api_key` which can be over-ridden.
 
 | Symbol | Envar API Key | Client Source |
 | --- | --- | --- |
@@ -63,6 +82,25 @@ extensions.
 | :open_router | [OPEN_ROUTER_API_KEY](https://openrouter.ai/) | AiClient Extension |
 | :openai | [OPENAI_API_KEY](https://www.openai.com/) | OmniAI |
 
+
+### Changing Envar API Key Names
+
+You can also configure the system environment variable names to match your on standards at the class level.
+
+```ruby
+AiClient.class_config.envar_api_key_bames = {
+  anthropic:    'your_envar_name',
+  google:       'your_envar_name',
+  mistral:      'your_envar_name',
+  open_router:  'your_envar_name',
+  opena:        'your_envar_name'
+}
+
+AiClient.class_config.save('path/to/file.yml')
+```
+
+### api_key: Parameter
+
 In case you are using a different environment variable for your access token than the ones shown above you can use the `api_key:` parameter.
 
 ```ruby
@@ -71,6 +109,12 @@ client = AiClient.new('provider/model_name', api_key: ENV['OPENROUTER_API_KEY'])
 
 This way if you are using `AiClient` inside of a Rails application you can retrieve your access token from a secretes file.
 
+
+### provider: Parameter
+
+To explicitly designate a provider to use with an AiClient instance use the parameter `provider: :your_provider` with the Symbol for the supported provider you want to use with the model you specify.  The following providers are supported by the OmniAI gem upon which AiClient depends along with a few extensions.
+
+
 ## Usage
 
 Basic usage:
@@ -95,22 +139,17 @@ AI = AiClient.new('nomic-embed-text', provider: :ollama)
 
 ### Configuration
 
-There are three levels of configuration, each inherenting from the level above. The following sections
-describe those configuration levels.
+There are three levels of configuration, each inherenting from the level above. The following sections describe those configuration levels.
 
 #### Default Configuration
 
-The file [lib/ai_client/configuration.rb] hard codes the default configuration.  This is used to
-update the [lib/ai_client/config.yml] file during development.  If you have
-some changes for this configuration please send me a pull request so we
-can all benefit from your efforts.
+The file [lib/ai_client/configuration.rb] hard codes the default configuration.  This is used to update the [lib/ai_client/config.yml] file during development.  If you have some changes for this configuration please send me a pull request so we can all benefit from your efforts.
 
 #### Class Configuration
 
-The class configuration is derived initially from the default configuration.  It
-can be changed in three ways.
+The class configuration is derived initially from the default configuration.  It can be changed in three ways.
 
-1. Class Configuration Block
+##### 1. Class Configuration Block
 
 ```ruby
 AiClient.configuration do |config|
@@ -119,13 +158,13 @@ AiClient.configuration do |config|
 end
 ```
 
-2. Set by a Config File
+##### 2. Set by a Config File
 
 ```ruby
 AiClient.class_config = AiClient::Config.load('path/to/file.yml')
 ```
 
-3. Supplemented by a Config File
+##### 3. Supplemented by a Config File
 
 ```ruby
 AiClient.class_config.merge! AiClient::Config.load('path/to/file.yml')
@@ -133,12 +172,9 @@ AiClient.class_config.merge! AiClient::Config.load('path/to/file.yml')
 
 #### Instance Configuration
 
-All instances have a configuration.  Initially that configuration is the same
-as the class configuration; however, each instance can have its own separate
-configuration.  For an instance the class configuration can either be supplemented 
-or complete over-ridden.
+All instances have a configuration.  Initially that configuration is the same as the class configuration; however, each instance can have its own separate configuration.  For an instance the class configuration can either be supplemented or complete over-ridden.
 
-1. Supplement from a Constructor Block
+##### 1. Supplement from a Constructor Block
 
 ```ruby
 client = AiClient.new('super-ai-overlord-model') do |config|
@@ -147,43 +183,111 @@ client = AiClient.new('super-ai-overlord-model') do |config|
 end
 ```
 
-2. Suppliment from a YAML File
+##### 2. Supplement from a YAML File
 
 ```ruby
 client = AiClient.new('baby-model', config: 'path/to/file.yml')
 ```
 
-3. Load Complete Configuration from a YAML File
+##### 3. Load Complete Configuration from a YAML File
 
 ```ruby
 client = AiClient.new('your-model')
 client.config = AiClient::Config.load('path/to/file.yml')
 ```
 
-### What Now?
+### Top-level Client Methods
+
+See the [examples directory](examples/README.md) for some ideas on how to use AiClient.
+
+The following examples are based upon the same client configuration.
+
+```ruby
+AI = AiClient.new(...) do ... end
+```
+
+##### chat
+
+Typically `chat(...)` is the most used top-level.  Sometimes refered to as completion.  You are giving a prompt to an LLM and expecting the LLM to respond (ie. complete its transformation).  If you consider the prompt to be a question, the response would be the answer.  If the prompt were a task, the response would be the completion of that task.
+
+```ruby
+response = AI.chat(...)
+```
+
+The simplest form is a string prompt.  The prompt can come from anywher - a litteral, variable, or get if from a database or a file.
+
+```ruby
+response = AI.chat("Is there anything simpler than this?")
+```
+
+The response will be a simple string or a response object based upon the setting of your `config.return_raw` item.  If `true` then you get the whole shebang.  If `false` you get just the string.
+
+See the [Advanced Prompts] section to learn how to configure a complex prompt message.
+
+
+##### embed
 
-TODO: Document the methods and their options.
+Embeddings (as in 'embed additional information') is how retrial augmented generation (RAG) works - which is a deeper subject for another place.  Basically when using an LLM that supports the vectorization of stuff to create embeddings you can use `embed(stuff)` to return the vector associated with the stuff you gave the model.  This vector (an Array of Floating Points Numbers) is a mathematical representation of the stuff that can be used to compare, mathematically, one piece of stuff to a collection of stuff to find other stuff in that collection that closely resembles the stuff for which you are looking.  Q: What is stuff?  A: You know; its just stuff.
 
 ```ruby
-AI.chat(...)
-AI.transcribe(...)
-AI.speak(...)
 AI.embed(...)
-AI.batch_embed(...)
+response = AI.batch_embed(...)
 ```
 
-See the [examples directory](examples/README.md) for some ideas on how to use AiClient.
+Recommendation: Use PostgreSQL, pg_vector and the neighbor gem.
+
+##### speak
 
-### System Environment Variables
+```ruby
+res[pmse = AI.speak("Isn't it nice to have a computer that will talk to you?")
+```
+
+The response will contain audio data that can be played, manipulated or saved to a file.
+
+##### transcribe
+
+```ruby
+response = AI.transcribe(...)
+```
 
-The API keys used with each LLM provider have the pattern `XXX_API_KEY` where XXX is the name of the provided.  For example `OPENAI_API_KEY1` and `ANTROPIC_API_KEY` etc.
 
-TODO: list all providers supported and their envar
 
 ### Options
 
 TODO: document the options like `provider: :ollama`
 
+### Advanced Prompts
+
+In more complex application providing a simple string as your prompt is not sufficient.  AiClient can take advantage of OmniAI's complex message builder.
+
+```ruby
+client = AiClient.new 'some_model_bane'
+
+completion = client.chat do |prompt|
+  prompt.system('You are an expert biologist with an expertise in animals.')
+  prompt.user do |message|
+    message.text 'What species are in the attached photos?'
+    message.url('https://.../cat.jpeg', "image/jpeg")
+    message.url('https://.../dog.jpeg', "image/jpeg")
+    message.file('./hamster.jpeg', "image/jpeg")
+  end
+end
+
+completion #=> 'The photos are of a cat, a dog, and a hamster.'
+```
+
+Of course if `client.config.return_raw` is true, the completion value will be the complete response object.
+
+### Advanced Prompts with Tools
+
+One of the latest innovations in LLMs is the ability to use functions (aka tools) as `callbacks` to gather more information or to execute a task at the direction of the LLM prompt processing.
+
+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
+
+
 ## Best ?? Practices
 
 If you are going to be using one model for multiple purposes in different parts of your application you can assign the instance of `AiClient` to a constant so that the same client can be used everywhere.
@@ -199,18 +303,9 @@ AI.speak "warning  Will Robinson! #{bad_things_happened}"
 
 Using the constant for the instance allows you to reference the same client instance inside any method through out your application.  Of course it does not apply to only one instance.  You could assign multiple instances for different models/providers.  For example you could have `AI` for your primary client and `AIbackup` for a fallback client in case you have a problem on the primary; or, maybe `Vectorizer` as a client name tied to a model specializing in embedding vectorization.
 
-## Extensions for OmniAI
-
-The AiClient makes use of extensions to the OmniAI gem that define
-additional providers and protocols.
-
-1. **OmniAI::Ollama^** which wraps the OmniAI::OpenAI class
-2. **OmniAI::LocalAI** which also wraps the OmniAI::OpenAI class
-3. **OmniAI::OpenRouter**  TODO: Still under development
-
 ## OmniAI and OpenRouter
 
-OmniAI is a Ruby gem that supports specific providers directly using a common-ish API.  You incur costs directly from those providers for which you have individual API keys (aka access tokens.) OpenRouter, on the other hand, is a web service that also establishes a common API for many providers and models; however, OpenRouter adds a small fee on top of the fee charged by those providers.  You trade off cost for flexibility.  With OpenRouter you only need one API key (OPEN_ROUTER_API_KEY) to access all of its supported services.
+Both OmniAI and OpenRouter have similar goals - to provide a common interface to multiple providers and LLMs.  OmniAI is a Ruby gem that supports specific providers directly using a common-ish API.  You incur costs directly from those providers for which you have individual API keys (aka access tokens.) OpenRouter, on the other hand, is a web service that also establishes a common API for many providers and models; however, OpenRouter adds a small fee on top of the fee charged by those providers.  You trade off cost for flexibility.  With OpenRouter you only need one API key (OPEN_ROUTER_API_KEY) to access all of its supported services.
 
 The advantage of AiClient is that you have the added flexibility to choose on a client by client bases where you want your model to be processed.  You get free local processing through Ollama and LocalAI.  You get less costly direct access to some providers via OmniAI.  You get slightly more costly wide-spread access via OpenRouter
 

data/Rakefile

@@ -3,6 +3,14 @@
 require "bundler/gem_tasks"
 require "minitest/test_task"
 
+begin
+  require "tocer/rake/register"
+rescue LoadError => error
+  puts error.message
+end
+
+Tocer::Rake::Register.call
+
 Minitest::TestTask.create
 
 task default: :test

data/lib/ai_client/config.yml

@@ -14,11 +14,23 @@
     binmode: false
     reraise_write_errors: []
     mon_data: !ruby/object:Monitor {}
-    mon_data_owner_object_id: 920
+    mon_data_owner_object_id: 45380
   level_override: {}
 :timeout:
 :return_raw: false
 :providers: {}
+:envar_api_key_names:
+  :anthropic:
+  - ANTHROPIC_API_KEY
+  :google:
+  - GOOGLE_API_KEY
+  :mistral:
+  - MISTRAL_API_KEY
+  :open_router:
+  - OPEN_ROUTER_API_KEY
+  - OPENROUTER_API_KEY
+  :openai:
+  - OPENAI_API_KEY
 :provider_patterns:
   :anthropic: !ruby/regexp /^claude/i
   :openai: !ruby/regexp /^(gpt|chatgpt|o1|davinci|curie|babbage|ada|whisper|tts|dall-e)/i

data/lib/ai_client/configuration.rb

@@ -91,16 +91,6 @@ class AiClient
     include Hashie::Extensions::Mash::PermissiveRespondTo
     include Hashie::Extensions::Mash::SymbolizeKeys
     include Hashie::Extensions::Mash::DefineAccessors
-  
-
-    # I'm not sure about this ...
-    # def provider(name, &block)
-    #   if block_given?
-    #     providers[name] = block.call
-    #   else
-    #     providers[name] || {}
-    #   end
-    # end
 
 
     def save(filepath=ENV['HOME']+'/aiclient_config.yml')
@@ -129,6 +119,11 @@ class AiClient
       yield(class_config)
     end
 
+    def reset_default_config
+      initialize_defaults
+        .save(Config::DEFAULT_CONFIG_FILEPATH)      
+    end
+
     private
 
     def initialize_defaults
@@ -137,6 +132,13 @@ class AiClient
         timeout: nil,
         return_raw: false,
         providers: {},
+        envar_api_key_names: {
+          anthropic: ['ANTHROPIC_API_KEY'],
+          google: ['GOOGLE_API_KEY'],
+          mistral: ['MISTRAL_API_KEY'],
+          open_router: ['OPEN_ROUTER_API_KEY', 'OPENROUTER_API_KEY'],
+          openai: ['OPENAI_API_KEY']
+        },
         provider_patterns: {
           anthropic: /^claude/i,
           openai: /^(gpt|chatgpt|o1|davinci|curie|babbage|ada|whisper|tts|dall-e)/i,

data/lib/ai_client/llm.rb

@@ -0,0 +1,23 @@
+# lib/ai_client/llm.rb
+
+require 'active_hash'
+require 'yaml'
+
+
+class AiClient
+  class LLM < ActiveHash::Base
+    DATA_PATH = Pathname.new( __dir__ + '/models.yml')
+    self.data = YAML.parse(DATA_PATH.read).to_ruby 
+
+    def model     = id.split('/')[1]
+    def provider  = id.split('/')[0]
+  end
+
+  class << self
+    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