ai_client 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 320868a04996fe7ce2b99555b9d5b7c39579eff8be6e73a2ce60534720bd6dbb
-  data.tar.gz: 87b7cf31ba5be1a8acb03a0b56f54ef741e8e1ba0cc03b34045c10768186729d
+  metadata.gz: 72666a60d1c49346ce8512fbfe97fbc163801f5cc22e9f7ed3883c3c8e28901b
+  data.tar.gz: bbcaee95e9ef2a6fd8bad5159ff8aa6d8cc88f443302dd37573c0bf7da512a66
 SHA512:
-  metadata.gz: c5c96015690e48c578cf88eee643a6b5c4fea551418177b7d2f883114514a469761a502d57846976efac27f2e470b0d7cf37d646e01add5539bc40da3ab50b72
-  data.tar.gz: ab0583961a965fbc7fd51b6159bbde629d19db1ef0105c6d6567f692fc64ca42ac714b488e01aacafa4165345f74a7b9482d1f4107651e591cb337a6a8a79d27
+  metadata.gz: 04045a6f8a78671930429f9481e4319b36cf5955d802f8f6ae5b4ec6c4bd1b4c88d4854bcaa44fbb3b4a0f4b7d68c7a4f3d0c4045c767c590cf417efac905e5f
+  data.tar.gz: d26f1770c0dd38d6c83fed91eca4e8489ac485415b91bb0e0d5ef0496f09af20f0e532974b984fcabedd997562494f20881966b3b5bee0e1a091013431f5e18d

data/CHANGELOG.md

@@ -1,12 +1,22 @@
 ## [Unreleased]
 
-### [0.3.0] - 2024-10-13
+## Released
+
+### [0.4.0] - 2024-10-20
+- Removed Logger.new(STDOUT) from the default configuration
+  > config.logger now returns nil  If you want a class or instance logger setup, then you will have to do a config.logger = Logger.new(STDOUT) or whatever you need.
+- Adding basic @context for chat-bots
+- Added `context_length` to configuration as the number of responses to remember as context
+- Added a default model for each major provider; using "auto" for open_router.ai
+- Added a default provider (OpenAI)
+  > AiClient.new() will use the config.default_provider and that provider's default_model
+- Fixed problem with advanced block-based prompt construction for chat
+
+### [0.3.1] - 2024-10-19
 - updated the open_routed_extensions file
 - added simplecov to see code coverage
 - updated README with options doc
 
-## Released
-
 ### [0.3.0] - 2024-10-13
 - Breaking Change
 - Added new class AiClient::Function to encapsulate the callback functions used as tools in chats.

data/README.md

@@ -2,11 +2,13 @@
 
 First and foremost a big **THANK YOU** to [Kevin Sylvestre](https://ksylvest.com/) for his gem [OmniAI](https://github.com/ksylvest/omniai) and [Olympia](https://olympia.chat/) for their [open_router gem](https://github.com/OlympiaAI/open_router) upon which this effort depends.
 
-Version 0.3.0 has a breaking change w/r/t how [Callback Functions (aka Tools)](#callback-functions-aka-tools) are defined and used.
+Version 0.4.0 has two changes which may break your existing application.
+1. The default configuration no longer has a Logger instance.  You will need to add your own instance to either the class or instance configuration using `AiClient.class_config.logger = YourLogger` and/or `client.config.logger = YourLogger`
+2. The `chat` method now keeps a context window.  The window length is defined by the configuration item `context_length`  If you do not want to maintain a context window, set the `context_length` configuration item to either nil or zero.
 
 See the  [change log](CHANGELOG.md) for recent modifications.
 
-You should also checkout the [raix gem](https://github.com/OlympiaAI/raix).  I like the way that Obie's API is setup for callback functions.  `raix-rails` is also available.
+You should also checkout the [raix gem](https://github.com/OlympiaAI/raix).  I like the way that Obie's API is setup for callback functions.  [raix-rails](https://github.com/OlympiaAI/raix-rails) is also available.
 
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
@@ -32,6 +34,7 @@ You should also checkout the [raix gem](https://github.com/OlympiaAI/raix).  I l
         - [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)
+            - [Cpmtext](#cpmtext)
         - [embed](#embed)
         - [speak](#speak)
         - [transcribe](#transcribe)
@@ -112,7 +115,7 @@ AiClient.class_config.envar_api_key_bames = {
   google:       'your_envar_name',
   mistral:      'your_envar_name',
   open_router:  'your_envar_name',
-  opena:        'your_envar_name'
+  openai:       'your_envar_name'
 }
 
 AiClient.class_config.save('path/to/file.yml')
@@ -139,13 +142,49 @@ To explicitly designate a provider to use with an AiClient instance use the para
 Basic usage:
 
 ```ruby
-AI = AiClient.new('gpt-4o')
+require 'ai_client'
+ai = AiClient.new # use default model and provider
+ai.model    #=> 'gpt-4o' is the default
+ai.provider #=> :openai  is the default
+#
+# To change the class defaults:
+#
+AiClient.default_provider       = :anthropic
+AiClient.default_model[:openai] = 'gpt-4o-mini'
+#
+# To get an Array of models and providers
+#
+AiClient.models     # from open_router.ai
+AiClient.providers  # from open_router.ai
+#
+# To get details about a specific provider/model pair:
+#
+AiClient.model_details('openai/gpt-4o-mini')  # from open_router.ai
 ```
 
-That's it.  Just provide the model name that you want to use.  If you application is using more than one model, no worries, just create multiple AiClient instances.
+You can specify which model you want to use and `AiClient` will use the provider associated with that model.
+
+
+```ruby
+AI = AiClient.new('gpt-4o-mini') # sets provider to :openai
+#
+# If you want to use the open_router.ai service instead of
+# going directly to OpenAI do it this way:
+#
+AI = AiClient.new('openai/gpt-4o-mini') # sets provider to :open_router
+```
+
+Of course you could specify both the model and the provider that you want to use:
+
 
 ```ruby
-c1 = AiClient.new('nomic-embeddings-text')
+AI = AiClient.new('mistral', provider: :ollama)
+```
+
+That's it.  What could be simpler?  If your application is using more than one model, no worries, just create multiple `AiClient` instances.
+
+```ruby
+c1 = AiClient.new('nomic-embed-text')
 c2 = AiClient.new('gpt-4o-mini')
 ```
 
@@ -164,6 +203,53 @@ There are three levels of configuration, each inherenting from the level above.
 
 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.
 
+```ruby
+{
+                 :logger => nil,
+                :timeout => nil,
+             :return_raw => false,
+         :context_length => 5,
+              :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,
+             :google => /^(gemini|gemma|palm)/i,
+            :mistral => /^(mistral|codestral|mixtral)/i,
+            :localai => /^local-/i,
+             :ollama => /(llama|nomic)/i,
+        :open_router => /\//
+    },
+       :default_provider => :openai,
+          :default_model => {
+          :anthropic => "claude-3-5-sonnet-20240620",
+             :openai => "gpt-4o",
+             :google => "gemini-pro-1.5",
+            :mistral => "mistral-large",
+            :localai => "llama3.2",
+             :ollama => "llama3.2",
+        :open_router => "auto"
+    }
+}
+```
+
 #### Class Configuration
 
 The class configuration is derived initially from the default configuration.  It can be changed in three ways.
@@ -243,6 +329,16 @@ The response will be a simple string or a response object based upon the setting
 
 See the [Advanced Prompts] section to learn how to configure a complex prompt message.
 
+####### Cpmtext
+
+**context_length**
+
+The `context_length` configuration item is used to keep the last "context_length" responses within the chat context window.  If you do not want to keep a context window, you should set the value of `config.context_length = 0`  When you do either at the class or instance level, the chat response will be provided without the LLM knowing any prior context.  If you are implementing a chat-bot, you will want it to have a context of the current conversation.
+
+```ruby
+AiClient.config.context_length #=> 5
+AiClient.config.context_length = 0  # Turns off the context window
+```
 
 ##### embed
 
@@ -258,7 +354,7 @@ Recommendation: Use PostgreSQL, pg_vector and the neighbor gem.
 ##### speak
 
 ```ruby
-res[pmse = AI.speak("Isn't it nice to have a computer that will talk to you?")
+response = 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.
@@ -313,7 +409,7 @@ Note: The availability and exact names of these options may vary depending on th
 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'
+client = AiClient.new 'some_model_name'
 
 completion = client.chat do |prompt|
   prompt.system('You are an expert biologist with an expertise in animals.')

data/lib/ai_client/chat.rb

@@ -9,8 +9,17 @@ class AiClient
   #   stream:       @stream   [Proc, nil] optional
   #   tools:        @tools    [Array<OmniAI::Tool>] optional
   #   temperature:  @temperature  [Float, nil] optional
-
-  def chat(messages, **params)    
+  #
+  # Initiates a chat session.
+  #
+  # @param messages [Array<String>] the messages to send.
+  # @param params [Hash] optional parameters.
+  # @option params [Array<OmniAI::Tool>] :tools an array of tools to use.
+  # @return [String] the result from the chat.
+  #
+  # @raise [RuntimeError] if tools parameter is invalid.
+  #
+  def chat(messages='', **params, &block)    
     if params.has_key? :tools
       tools = params[:tools]
       if tools.is_a? Array
@@ -23,14 +32,62 @@ class AiClient
       params[:tools] = tools
     end
 
-    result = call_with_middlewares(:chat_without_middlewares, messages, **params)
-    @last_response = result
-    raw? ? result : content
+    @last_messages  = messages
+    messages        = add_context(messages)
+    result          = call_with_middlewares(
+                        :chat_without_middlewares, 
+                        messages, 
+                        **params,
+                        &block
+                      )
+    @last_response  = result
+    result          = raw? ? result : content
+
+    @context.push(@last_response)
+
+    result
   end
 
 
-  def chat_without_middlewares(messages, **params)
-    @client.chat(messages, model: @model, **params)
+  # Adds context to the current prompt.
+  #
+  # @param prompt [String, Array<String>] the current prompt.
+  # @return [String, Array<String>] the prompt with context added.
+  #
+  def add_context(prompt)
+    return(prompt)  if  @config.context_length.nil? || 
+                        0 == @config.context_length ||
+                        prompt.is_a?(Array)         || 
+                        @context.empty?
+
+
+    prompt << "\nUse the following context in crafting your response.\n"
+
+    @context[..config.context_length].each do |result|
+      prompt << "You previously responded with:\n"
+      prompt << "#{raw? ? result.inspect : content(result)}"
+    end
+
+    prompt
+  end
+
+
+  # Clears the current context.
+  #
+  # @return [void]
+  #
+  def clear_context
+    @context = []
   end
 
+
+  # Chats with the client without middleware processing.
+  #
+  # @param messages [Array<String>] the messages to send.
+  # @param params [Hash] optional parameters.
+  # @return [String] the result from the chat.
+  #
+  def chat_without_middlewares(messages, **params, &block)
+    @client.chat(messages, model: @model, **params, &block)
+  end
 end

data/lib/ai_client/config.yml

@@ -1,23 +1,8 @@
 ---
-:logger: !ruby/object:Logger
-  level: 0
-  progname:
-  default_formatter: !ruby/object:Logger::Formatter
-    datetime_format:
-  formatter:
-  logdev: !ruby/object:Logger::LogDevice
-    shift_period_suffix:
-    shift_size:
-    shift_age:
-    filename:
-    dev: !ruby/object:IO {}
-    binmode: false
-    reraise_write_errors: []
-    mon_data: !ruby/object:Monitor {}
-    mon_data_owner_object_id: 45380
-  level_override: {}
+:logger:
 :timeout:
 :return_raw: false
+:context_length: 5
 :providers: {}
 :envar_api_key_names:
   :anthropic:
@@ -39,3 +24,12 @@
   :localai: !ruby/regexp /^local-/i
   :ollama: !ruby/regexp /(llama|nomic)/i
   :open_router: !ruby/regexp /\//
+:default_provider: :openai
+:default_model:
+  :anthropic: claude-3-5-sonnet-20240620
+  :openai: gpt-4o
+  :google: gemini-pro-1.5
+  :mistral: mistral-large
+  :localai: llama3.2
+  :ollama: llama3.2
+  :open_router: auto

data/lib/ai_client/configuration.rb

@@ -152,9 +152,10 @@ class AiClient
     #
     def initialize_defaults
       @default_config = Config.new(
-        logger: Logger.new(STDOUT),
+        logger: nil, # Logger.new(STDOUT),
         timeout: nil,
         return_raw: false,
+        context_length: 5, # number of responses to add as context
         providers: {},
         envar_api_key_names: {
           anthropic: ['ANTHROPIC_API_KEY'],
@@ -171,6 +172,16 @@ class AiClient
           localai: /^local-/i,
           ollama: /(llama|nomic)/i,
           open_router: /\//
+        },
+        default_provider: :openai,
+        default_model: {
+          anthropic: 'claude-3-5-sonnet-20240620',
+          openai: 'gpt-4o',
+          google: 'gemini-pro-1.5',
+          mistral: 'mistral-large',
+          localai: 'llama3.2',
+          ollama: 'llama3.2',
+          open_router: 'auto'
         }
       )
 

data/lib/ai_client/middleware.rb

@@ -23,7 +23,7 @@ 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) }
+      -> { middleware.call(self, next_middleware, *args, **kwargs, &block) }
     end
     stack.call
   end