boxcars 0.7.6 → 0.8.0

data/lib/boxcars/engine/google.rb

@@ -21,8 +21,8 @@ module Boxcars
     # @param prompts [Array<Prompt>] The prompts to use for the Engine.
     # @param batch_size [Integer] The number of prompts to send to the Engine at a time.
     # @param kwargs [Hash] Additional parameters to pass to the Engine.
-    def initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, prompts: [], batch_size: 20, **kwargs)
-      super(provider: :google, description: description, name: name, prompts: prompts, batch_size: batch_size, **kwargs)
+    def initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, prompts: [], batch_size: 20, **)
+      super(provider: :google, description:, name:, prompts:, batch_size:, **)
     end
 
     def default_model_params

data/lib/boxcars/engine/gpt4all_eng.rb

@@ -1,56 +1,114 @@
 # frozen_string_literal: true
 
 require 'gpt4all'
-# Boxcars is a framework for running a series of tools to get an answer to a question.
+require 'json' # For pretty_generate
+
 module Boxcars
   # A engine that uses local GPT4All API.
   class Gpt4allEng < Engine
-    attr_reader :prompts, :model_kwargs, :batch_size
+    include UnifiedObservability
+    attr_reader :prompts, :model_kwargs, :batch_size, :gpt4all_params # Added gpt4all_params
 
-    # the default name of the engine
     DEFAULT_NAME = "Gpt4all engine"
-    # the default description of the engine
     DEFAULT_DESCRIPTION = "useful for when you need to use local AI to answer questions. " \
                           "You should ask targeted questions"
+    # GPT4All doesn't have typical API params like temperature or model selection via params in the same way.
+    # Model is usually pre-loaded. We can add a placeholder for model_name if needed for tracking.
+    DEFAULT_PARAMS = {
+      model_name: "gpt4all-j-v1.3-groovy" # Example, actual model depends on local setup
+    }.freeze
 
-    # A engine is a container for a single tool to run.
-    # @param name [String] The name of the engine. Defaults to "OpenAI engine".
-    # @param description [String] A description of the engine. Defaults to:
-    #        useful for when you need to use AI to answer questions. You should ask targeted questions".
-    # @param prompts [Array<String>] The prompts to use when asking the engine. Defaults to [].
-    # @param batch_size [Integer] The number of prompts to send to the engine at once. Defaults to 2.
-    def initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, prompts: [], batch_size: 2, **_kwargs)
+    def initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, prompts: [], batch_size: 2, **kwargs)
+      @gpt4all_params = DEFAULT_PARAMS.merge(kwargs) # Store merged params
       @prompts = prompts
-      @batch_size = batch_size
-      super(description: description, name: name)
+      @batch_size = batch_size # Retain if used by other methods
+      super(description:, name:)
     end
 
-    # Get an answer from the engine.
-    # @param prompt [String] The prompt to use when asking the engine.
-    # @param openai_access_token [String] The access token to use when asking the engine.
-    #   Defaults to Boxcars.configuration.openai_access_token.
-    # @param kwargs [Hash] Additional parameters to pass to the engine if wanted.
-    def client(prompt:, inputs: {}, **_kwargs)
-      gpt4all = Gpt4all::ConversationalAI.new
-      gpt4all.prepare_resources(force_download: false)
-      gpt4all.start_bot
-      input_text = prompt.as_prompt(inputs: inputs)[:prompt]
-      Boxcars.debug("Prompt after formatting:\n#{input_text}", :cyan) if Boxcars.configuration.log_prompts
-      gpt4all.prompt(input_text)
-    rescue StandardError => e
-      Boxcars.error(["Error from gpt4all engine: #{e}", e.backtrace[-5..-1]].flatten.join("\n   "))
-    ensure
-      gpt4all.stop_bot
+    def client(prompt:, inputs: {}, **kwargs)
+      start_time = Time.now
+      response_data = { response_obj: nil, parsed_json: nil, success: false, error: nil, status_code: nil }
+      # current_params are the effective parameters for this call, including defaults and overrides
+      current_params = @gpt4all_params.merge(kwargs)
+      # api_request_params for GPT4All is just the input text.
+      api_request_params = nil
+      current_prompt_object = prompt.is_a?(Array) ? prompt.first : prompt
+      gpt4all_instance = nil # To ensure it's in scope for ensure block
+
+      begin
+        gpt4all_instance = Gpt4all::ConversationalAI.new
+        # prepare_resources might download models, could take time.
+        # Consider if this setup should be outside the timed/tracked client call for long-running setup.
+        # For now, including it as it's part of the interaction.
+        gpt4all_instance.prepare_resources(force_download: false)
+        gpt4all_instance.start_bot
+
+        # GPT4All gem's prompt method takes a string.
+        prompt_text_for_api = current_prompt_object.as_prompt(inputs:)
+        prompt_text_for_api = prompt_text_for_api[:prompt] if prompt_text_for_api.is_a?(Hash) && prompt_text_for_api.key?(:prompt)
+        api_request_params = { prompt: prompt_text_for_api } # Store what's sent
+
+        Boxcars.debug("Prompt after formatting:\n#{prompt_text_for_api}", :cyan) if Boxcars.configuration.log_prompts
+
+        raw_response_text = gpt4all_instance.prompt(prompt_text_for_api) # Actual call
+
+        # GPT4All gem returns a string directly, or raises error.
+        response_data[:response_obj] = raw_response_text # Store the raw string
+        response_data[:parsed_json] = { "text" => raw_response_text } # Create a simple hash for consistency
+        response_data[:success] = true
+        response_data[:status_code] = 200 # Inferred for local success
+      rescue StandardError => e
+        response_data[:error] = e
+        response_data[:success] = false
+        # No HTTP status code for local errors typically, unless the gem provides one.
+      ensure
+        gpt4all_instance&.stop_bot # Ensure bot is stopped even if errors occur
+
+        duration_ms = ((Time.now - start_time) * 1000).round
+        request_context = {
+          prompt: current_prompt_object,
+          inputs:,
+          conversation_for_api: api_request_params&.dig(:prompt) # The text prompt
+        }
+
+        track_ai_generation(
+          duration_ms:,
+          current_params:,
+          request_context:,
+          response_data:,
+          provider: :gpt4all
+        )
+      end
+
+      _gpt4all_handle_call_outcome(response_data:)
     end
 
-    # get an answer from the engine for a question.
-    # @param question [String] The question to ask the engine.
-    # @param kwargs [Hash] Additional parameters to pass to the engine if wanted.
-    def run(question, **kwargs)
+    def run(question, **)
       prompt = Prompt.new(template: question)
-      answer = client(prompt: prompt, **kwargs)
+      answer = client(prompt:, inputs: {}, **)
       Boxcars.debug("Answer: #{answer}", :cyan)
       answer
     end
+
+    # Added for consistency
+    def default_params
+      @gpt4all_params
+    end
+
+    private
+
+    def _gpt4all_handle_call_outcome(response_data:)
+      if response_data[:error]
+        # The original code had a specific error logging format.
+        Boxcars.error(["Error from gpt4all engine: #{response_data[:error].message}",
+                       response_data[:error].backtrace&.first(5)&.join("\n   ")].compact.join("\n   "), :red)
+        raise response_data[:error]
+      elsif !response_data[:success]
+        # This case might be redundant if gpt4all gem always raises on error
+        raise Error, "Unknown error from Gpt4all"
+      else
+        response_data.dig(:parsed_json, "text") # Extract the text from our structured hash
+      end
+    end
   end
 end

data/lib/boxcars/engine/groq.rb

@@ -1,119 +1,170 @@
 # frozen_string_literal: true
 
-# Boxcars is a framework for running a series of tools to get an answer to a question.
+require 'openai' # Groq uses the OpenAI gem with a custom URI base
+require 'json'
+
 module Boxcars
   # A engine that uses Groq's API.
   class Groq < Engine
-    attr_reader :prompts, :groq_parmas, :model_kwargs, :batch_size
+    include UnifiedObservability
+    attr_reader :prompts, :groq_params, :model_kwargs, :batch_size
 
-    # The default parameters to use when asking the engine.
     DEFAULT_PARAMS = {
       model: "llama3-70b-8192",
       temperature: 0.1,
-      max_tokens: 4096
+      max_tokens: 4096 # Groq API might have specific limits or naming for this
     }.freeze
-
-    # the default name of the engine
     DEFAULT_NAME = "Groq engine"
-    # the default description of the engine
-    DEFAULT_DESCRIPTION = "useful for when you need to use AI to answer questions. " \
+    DEFAULT_DESCRIPTION = "useful for when you need to use Groq AI to answer questions. " \
                           "You should ask targeted questions"
 
-    # A engine is a container for a single tool to run.
-    # @param name [String] The name of the engine. Defaults to "Groq engine".
-    # @param description [String] A description of the engine. Defaults to:
-    #        useful for when you need to use AI to answer questions. You should ask targeted questions".
-    # @param prompts [Array<String>] The prompts to use when asking the engine. Defaults to [].
-    # @param batch_size [Integer] The number of prompts to send to the engine at once. Defaults to 20.
     def initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, prompts: [], batch_size: 20, **kwargs)
-      @groq_parmas = DEFAULT_PARAMS.merge(kwargs)
+      @groq_params = DEFAULT_PARAMS.merge(kwargs) # Corrected typo here
       @prompts = prompts
       @batch_size = batch_size
-      super(description: description, name: name)
+      super(description:, name:)
     end
 
-    # Get the OpenAI API client
-    # @param groq_api_key [String] The access token to use when asking the engine.
-    #   Defaults to Boxcars.configuration.groq_api_key
-    # @return [OpenAI::Client] The OpenAI API gem client.
-    def self.open_ai_client(groq_api_key: nil)
-      access_token = Boxcars.configuration.groq_api_key(groq_api_key: groq_api_key)
-      ::OpenAI::Client.new(access_token: access_token, uri_base: "https://api.groq.com/openai")
+    # Renamed from open_ai_client to groq_client for clarity
+    def self.groq_client(groq_api_key: nil)
+      access_token = Boxcars.configuration.groq_api_key(groq_api_key:)
+      ::OpenAI::Client.new(access_token:, uri_base: "https://api.groq.com/openai/v1")
+      # Adjusted uri_base to include /v1 as is common for OpenAI-compatible APIs
     end
 
-    def conversation_model?(_model)
+    # Groq models are typically conversational.
+    def conversation_model?(_model_name)
       true
     end
 
-    # Get an answer from the engine.
-    # @param prompt [String] The prompt to use when asking the engine.
-    # @param groq_api_key [String] The access token to use when asking the engine.
-    #   Defaults to Boxcars.configuration.groq_api_key.
-    # @param kwargs [Hash] Additional parameters to pass to the engine if wanted.
     def client(prompt:, inputs: {}, groq_api_key: nil, **kwargs)
-      clnt = Groq.open_ai_client(groq_api_key: groq_api_key)
-      params = groq_parmas.merge(kwargs)
-      prompt = prompt.first if prompt.is_a?(Array)
-      params = prompt.as_messages(inputs).merge(params)
-      if Boxcars.configuration.log_prompts
-        Boxcars.debug(params[:messages].last(2).map { |p| ">>>>>> Role: #{p[:role]} <<<<<<\n#{p[:content]}" }.join("\n"), :cyan)
+      start_time = Time.now
+      response_data = { response_obj: nil, parsed_json: nil, success: false, error: nil, status_code: nil }
+      current_params = @groq_params.merge(kwargs)
+      current_prompt_object = prompt.is_a?(Array) ? prompt.first : prompt
+      api_request_params = nil # Initialize
+
+      begin
+        clnt = Groq.groq_client(groq_api_key:)
+        api_request_params = _prepare_groq_request_params(current_prompt_object, inputs, current_params)
+
+        log_messages_debug(api_request_params[:messages]) if Boxcars.configuration.log_prompts && api_request_params[:messages]
+
+        _execute_and_process_groq_call(clnt, api_request_params, response_data)
+      rescue ::OpenAI::Error => e
+        _handle_openai_error_for_groq(e, response_data)
+      rescue StandardError => e
+        _handle_standard_error_for_groq(e, response_data)
+      ensure
+        duration_ms = ((Time.now - start_time) * 1000).round
+        request_context = {
+          prompt: current_prompt_object,
+          inputs:,
+          conversation_for_api: api_request_params&.dig(:messages)
+        }
+        track_ai_generation(
+          duration_ms:,
+          current_params:,
+          request_context:,
+          response_data:,
+          provider: :groq
+        )
       end
-      clnt.chat(parameters: params)
-    rescue => e
-      Boxcars.error(e, :red)
-      raise
+
+      _groq_handle_call_outcome(response_data:)
     end
 
-    # get an answer from the engine for a question.
-    # @param question [String] The question to ask the engine.
-    # @param kwargs [Hash] Additional parameters to pass to the engine if wanted.
-    def run(question, **kwargs)
+    def run(question, **)
       prompt = Prompt.new(template: question)
-      response = client(prompt: prompt, **kwargs)
-      raise Error, "Groq: No response from API" unless response
-
-      check_response(response)
-      response["choices"].map { |c| c.dig("message", "content") || c["text"] }.join("\n").strip
+      answer = client(prompt:, inputs: {}, **)
+      Boxcars.debug("Answer: #{answer}", :cyan)
+      answer
     end
 
-    # Get the default parameters for the engine.
     def default_params
-      groq_parmas
+      @groq_params # Use instance variable
+    end
+
+    private
+
+    # Helper methods for the client method
+    def _prepare_groq_request_params(prompt_object, inputs, current_params)
+      messages_hash_from_prompt = prompt_object.as_messages(inputs)
+      actual_messages_for_api = messages_hash_from_prompt[:messages]
+      { messages: actual_messages_for_api }.merge(current_params)
     end
 
-    # make sure we got a valid response
-    # @param response [Hash] The response to check.
-    # @param must_haves [Array<String>] The keys that must be in the response. Defaults to %w[choices].
-    # @raise [KeyError] if there is an issue with the access token.
-    # @raise [ValueError] if the response is not valid.
+    def _execute_and_process_groq_call(clnt, api_request_params, response_data)
+      raw_response = clnt.chat(parameters: api_request_params)
+      response_data[:response_obj] = raw_response
+      response_data[:parsed_json] = raw_response # OpenAI gem returns Hash
+
+      if raw_response && !raw_response["error"] && raw_response["choices"]
+        response_data[:success] = true
+        response_data[:status_code] = 200 # Inferred
+      else
+        response_data[:success] = false
+        err_details = raw_response["error"] if raw_response
+        msg = if err_details
+                (err_details.is_a?(Hash) ? err_details['message'] : err_details).to_s
+              else
+                "Unknown Groq API Error"
+              end
+        response_data[:error] ||= StandardError.new(msg) # Use ||= to not overwrite existing exception
+      end
+    end
+
+    def _handle_openai_error_for_groq(error, response_data)
+      response_data[:error] = error
+      response_data[:success] = false
+      response_data[:status_code] = error.http_status if error.respond_to?(:http_status)
+    end
+
+    def _handle_standard_error_for_groq(error, response_data)
+      response_data[:error] = error
+      response_data[:success] = false
+    end
+
+    def log_messages_debug(messages)
+      return unless messages.is_a?(Array)
+
+      Boxcars.debug(messages.last(2).map { |p| ">>>>>> Role: #{p[:role]} <<<<<<\n#{p[:content]}" }.join("\n"), :cyan)
+    end
+
+    def _groq_handle_call_outcome(response_data:)
+      if response_data[:error]
+        Boxcars.error("Groq Error: #{response_data[:error].message} (#{response_data[:error].class.name})", :red)
+        raise response_data[:error]
+      elsif !response_data[:success]
+        err_details = response_data.dig(:response_obj, "error")
+        msg = if err_details
+                err_details.is_a?(Hash) ? "#{err_details['type']}: #{err_details['message']}" : err_details.to_s
+              else
+                "Unknown error from Groq API"
+              end
+        raise Error, msg
+      else
+        choices = response_data.dig(:parsed_json, "choices")
+        raise Error, "Groq: No choices found in response" unless choices.is_a?(Array) && !choices.empty?
+
+        choices.map { |c| c.dig("message", "content") || c["text"] }.join("\n").strip
+      end
+    end
+
+    # Retaining check_response if run method or other parts still use it.
     def check_response(response, must_haves: %w[choices])
       if response['error'].is_a?(Hash)
         code = response.dig('error', 'code')
         msg = response.dig('error', 'message') || 'unknown error'
-        raise KeyError, "GROQ_API_TOKEN not valid" if code == 'invalid_api_key'
+        # GROQ_API_TOKEN is not standard, usually it's an API key.
+        raise KeyError, "Groq API Key not valid or permission issue" if ['invalid_api_key', 'permission_denied'].include?(code)
 
         raise ValueError, "Groq error: #{msg}"
       end
 
       must_haves.each do |key|
-        raise ValueError, "Expecting key #{key} in response" unless response.key?(key)
+        raise ValueError, "Expecting key #{key} in response" unless response.key?(key) && !response[key].empty?
       end
     end
-
-    # the engine type
-    def engine_type
-      "groq"
-    end
-
-    # Calculate the maximum number of tokens possible to generate for a prompt.
-    # @param prompt_text [String] The prompt text to use.
-    # @return [Integer] the number of tokens possible to generate.
-    def max_tokens_for_prompt(prompt_text)
-      num_tokens = get_num_tokens(prompt_text)
-
-      # get max context size for model by name
-      max_size = 8096
-      max_size - num_tokens
-    end
   end
 end

data/lib/boxcars/engine/intelligence_base.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require 'intelligence'
+require_relative 'unified_observability'
 
 module Boxcars
   # A Base class for all Intelligence Engines
   class IntelligenceBase < Engine
+    include Boxcars::UnifiedObservability
     attr_reader :provider, :all_params
 
     # The base Intelligence Engine is used by other engines to generate output from prompts
@@ -16,8 +18,9 @@ module Boxcars
     # @param kwargs [Hash] Additional parameters to pass to the Engine.
     def initialize(provider:, description:, name:, prompts: [], batch_size: 20, **kwargs)
       @provider = provider
+      # Start with defaults, merge other kwargs, then explicitly set model if provided in initialize
       @all_params = default_model_params.merge(kwargs)
-      super(description: description, name: name, prompts: prompts, batch_size: batch_size)
+      super(description:, name:, prompts:, batch_size:)
     end
 
     # can be overridden by provider subclass
@@ -30,9 +33,10 @@ module Boxcars
     end
 
     def adapter(params:, api_key:)
-      Intelligence::Adapter[provider].new(
-        { key: api_key, chat_options: params }
-      )
+      Intelligence::Adapter.build! @provider do |config|
+        config.key api_key
+        config.chat_options params
+      end
     end
 
     # Process different content types
@@ -59,25 +63,56 @@ module Boxcars
     # Get an answer from the engine
     def client(prompt:, inputs: {}, api_key: nil, **kwargs)
       params = all_params.merge(kwargs)
-      api_key ||= lookup_provider_api_key(params: params)
+      api_key ||= lookup_provider_api_key(params:)
       raise Error, "No API key found for #{provider}" unless api_key
 
-      adapter = adapter(api_key: api_key, params: params)
-      convo = prompt.as_intelligence_conversation(inputs: inputs)
-      request = Intelligence::ChatRequest.new(adapter: adapter)
-      response = request.chat(convo)
-      return JSON.parse(response.body) if response.success?
-
-      raise Error, (response&.reason_phrase || "No response from API #{provider}")
-    rescue StandardError => e
-      Boxcars.error("#{provider} Error: #{e.message}", :red)
-      raise
+      adapter = adapter(api_key:, params:)
+      convo = prompt.as_intelligence_conversation(inputs:)
+      request_context = { prompt: prompt&.as_prompt(inputs:)&.[](:prompt), inputs:, conversation_for_api: convo.to_h }
+      request = Intelligence::ChatRequest.new(adapter:)
+
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      response_obj = nil
+
+      begin
+        response_obj = request.chat(convo)
+        duration_ms = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000
+
+        if response_obj.success?
+          success = true
+          parsed_json_response = JSON.parse(response_obj.body)
+          response_data = { success:, parsed_json: parsed_json_response, response_obj:,
+                            status_code: response_obj.status }
+          track_ai_generation(duration_ms:, current_params: params, request_context:, response_data:, provider:)
+          parsed_json_response
+        else
+          success = false
+          error_message = response_obj&.reason_phrase || "No response from API #{provider}"
+          response_data = { success:, error: StandardError.new(error_message), response_obj:,
+                            status_code: response_obj.status }
+          track_ai_generation(duration_ms:, current_params: params, request_context:, response_data:, provider:)
+          raise Error, error_message
+        end
+      rescue Error => e
+        # Re-raise Error exceptions (like the one above) without additional tracking
+        # since they were already tracked in the else branch
+        Boxcars.error("#{provider} Error: #{e.message}", :red)
+        raise
+      rescue StandardError => e
+        duration_ms = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000
+        success = false
+        error_obj = e
+        response_data = { success:, error: error_obj, response_obj:, status_code: response_obj&.status }
+        track_ai_generation(duration_ms:, current_params: params, request_context:, response_data:, provider:)
+        Boxcars.error("#{provider} Error: #{e.message}", :red)
+        raise
+      end
     end
 
     # Run the engine with a question
-    def run(question, **kwargs)
+    def run(question, **)
       prompt = Prompt.new(template: question)
-      response = client(prompt: prompt, **kwargs)
+      response = client(prompt:, **)
       extract_answer(response)
     end