boxcars 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c999092bd0fd0799ee3c97e74b0551e23fa5318eeb746fb17f52ed8b8e8e395
-  data.tar.gz: 9e4c76ab93ad3cf305af160679b05a46d4b72fb04d0ee40298b7e362d387e582
+  metadata.gz: 8d461b03fdcd5b35e5cf0d236917f5a1a875bc5ba1d0d87bcc51ac25d3060fbc
+  data.tar.gz: fab5696e09771665769e639c0bdffa4a48033d9befa0ddf4b95863bd1074f1b4
 SHA512:
-  metadata.gz: 2d7a5e62a2f0de60d789c97801d3832b2bd5aee4ceb82be59a8c1f66d724e931819412dede12027019c7d98b46b2a90e22c17660ed03ecab7d822ffa8290d260
-  data.tar.gz: a2b51cef624374b84506cb176a3ee5b5732db9fbd87ce4b824b803cf641a623c2e1bb9e22bcb65b7a230f261c913823f1fd65081ac6aa4e6c7068f620b82b63f
+  metadata.gz: 1ccdc812780d55b34f4e7d9f2990f66f3cb9d90ba603052e0f867c4fec08e93e0c015fd6d9fc502bd0857a9a4f7230102fd5566c0fb384f9e2c98e3d0e0c9566
+  data.tar.gz: 8b1e234aeba1a85d6551b7bce2dc81c1b37447a6553df6f11e72228315391b00482647e0fed27aa919557a6016ee70ab03d4fc19fdb686d277188b555890339c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxcars (0.8.6)
+    boxcars (0.8.7)
       faraday-retry (~> 2.0)
       google_search_results (~> 2.2)
       gpt4all (~> 0.0.5)

data/lib/boxcars/engine/anthropic.rb

@@ -122,23 +122,9 @@ module Boxcars
       end
     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 check_response(response, must_haves: %w[completion])
-      if response['error']
-        code = response.dig('error', 'code')
-        msg = response.dig('error', 'message') || 'unknown error'
-        raise KeyError, "ANTHOPIC_API_KEY not valid" if code == 'invalid_api_key'
-
-        raise ValueError, "Anthropic error: #{msg}"
-      end
-
-      must_haves.each do |key|
-        raise ValueError, "Expecting key #{key} in response" unless response.key?(key)
-      end
+    # validate_response! method uses the base implementation with Anthropic-specific must_haves
+    def validate_response!(response, must_haves: %w[completion])
+      super
     end
 
     # Call out to OpenAI's endpoint with k unique prompts.
@@ -155,7 +141,7 @@ module Boxcars
       prompts.each_slice(batch_size) do |sub_prompts|
         sub_prompts.each do |sprompts, inputs|
           response = client(prompt: sprompts, inputs:, **params)
-          check_response(response)
+          validate_response!(response)
           choices << response
         end
       end

data/lib/boxcars/engine/cohere.rb

@@ -114,23 +114,9 @@ module Boxcars
       llm_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 check_response(response, must_haves: %w[completion])
-      if response['error']
-        code = response.dig('error', 'code')
-        msg = response.dig('error', 'message') || 'unknown error'
-        raise KeyError, "ANTHOPIC_API_KEY not valid" if code == 'invalid_api_key'
-
-        raise ValueError, "Cohere error: #{msg}"
-      end
-
-      must_haves.each do |key|
-        raise ValueError, "Expecting key #{key} in response" unless response.key?(key)
-      end
+    # validate_response! method uses the base implementation with Cohere-specific must_haves
+    def validate_response!(response, must_haves: %w[completion])
+      super
     end
 
     # the engine type

data/lib/boxcars/engine/gemini_ai.rb

@@ -178,22 +178,9 @@ module Boxcars
       end
     end
 
-    # check_response method might be partially covered by _gemini_handle_call_outcome
-    # Retaining it if run method still uses it explicitly.
-    def check_response(response, must_haves: %w[choices candidates])
-      if response['error'].is_a?(Hash)
-        code = response.dig('error', 'code')
-        msg = response.dig('error', 'message') || 'unknown error'
-        # GEMINI_API_TOKEN is not standard, usually it's an API key.
-        # This check might need to align with actual error codes from Gemini.
-        raise KeyError, "Gemini API Key not valid or permission issue" if ['invalid_api_key', 'permission_denied'].include?(code)
-
-        raise ValueError, "GeminiAI error: #{msg}"
-      end
-
-      # Check for either 'choices' (OpenAI style) or 'candidates' (Gemini native style)
-      has_valid_content = must_haves.any? { |key| response.key?(key) && !response[key].empty? }
-      raise ValueError, "Expecting key like 'choices' or 'candidates' in response" unless has_valid_content
+    # validate_response! method uses the base implementation with Gemini-specific must_haves
+    def validate_response!(response, must_haves: %w[choices candidates])
+      super
     end
   end
 end

data/lib/boxcars/engine/groq.rb

@@ -157,20 +157,9 @@ module Boxcars
       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'
-        # 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) && !response[key].empty?
-      end
+    # validate_response! method uses the base implementation with Groq-specific must_haves
+    def validate_response!(response, must_haves: %w[choices])
+      super
     end
   end
 end

data/lib/boxcars/engine/intelligence_base.rb

@@ -119,10 +119,8 @@ module Boxcars
 
     private
 
-    def check_response(response)
-      return if response.is_a?(Hash) && response.key?("choices")
-
-      raise Error, "Invalid response from #{provider}: #{response}"
+    def validate_response!(response, must_haves: %w[choices])
+      super
     end
   end
 end

data/lib/boxcars/engine/openai.rb

@@ -100,14 +100,10 @@ module Boxcars
     end
 
     # -- Public helper -------------------------------------------------------------
-    # Some callers outside this class still invoke `check_response` directly.
+    # Some callers outside this class still invoke `validate_response!` directly.
     # It simply raises if the JSON body contains an "error" payload.
-    def check_response(response) # rubocop:disable Naming/PredicateMethod
-      if (msg = openai_error_message(response))
-        raise Boxcars::Error, msg
-      end
-
-      true
+    def validate_response!(response, must_haves: %w[choices])
+      super
     end
 
     private

data/lib/boxcars/engine/perplexityai.rb

@@ -55,10 +55,12 @@ module Boxcars
         messages_for_api = current_prompt_object.as_messages(inputs)[:messages]
         # Perplexity expects a 'model' and 'messages' structure.
         # Other params like temperature, max_tokens are top-level.
+        # Filter out parameters that Perplexity doesn't support
+        supported_params = filter_supported_params(current_params)
         api_request_params = {
-          model: current_params[:model],
+          model: supported_params[:model],
           messages: messages_for_api
-        }.merge(current_params.except(:model, :messages, :perplexity_api_key)) # Add other relevant params
+        }.merge(supported_params.except(:model, :messages, :perplexity_api_key))
 
         log_messages_debug(api_request_params[:messages]) if Boxcars.configuration.log_prompts && api_request_params[:messages]
 
@@ -115,17 +117,52 @@ module Boxcars
 
     def run(question, **)
       prompt = Prompt.new(template: question)
-      answer = client(prompt:, inputs: {}, **)
+      response = client(prompt:, inputs: {}, **)
+      # Extract the content from the response for the run method
+      answer = extract_answer(response)
       Boxcars.debug("Answer: #{answer}", :cyan)
       answer
     end
 
+    # Extract answer content from the API response
+    def extract_answer(response)
+      if response.is_a?(Hash) && response["choices"]
+        response["choices"].map { |c| c.dig("message", "content") }.join("\n").strip
+      else
+        response.to_s
+      end
+    end
+
     def default_params
       @perplexity_params
     end
 
+    # validate_response! method uses the base implementation
+    def validate_response!(response, must_haves: %w[choices])
+      super
+    end
+
     private
 
+    # Filter out parameters that Perplexity doesn't support
+    def filter_supported_params(params)
+      # Perplexity supports these parameters based on their API documentation
+      supported_keys = %i[
+        model
+        messages
+        temperature
+        max_tokens
+        top_p
+        top_k
+        stream
+        presence_penalty
+        frequency_penalty
+      ]
+
+      # Remove unsupported parameters like stop, response_format, etc.
+      params.select { |key, _| supported_keys.include?(key.to_sym) }
+    end
+
     def log_messages_debug(messages)
       return unless messages.is_a?(Array)
 
@@ -141,10 +178,14 @@ module Boxcars
         msg = err_details ? "#{err_details['type']}: #{err_details['message']}" : "Unknown error from PerplexityAI API"
         raise Error, msg
       else
-        choices = response_data.dig(:parsed_json, "choices")
-        raise Error, "PerplexityAI: No choices found in response" unless choices.is_a?(Array) && !choices.empty?
+        parsed_response = response_data[:parsed_json]
+        unless parsed_response["choices"].is_a?(Array) && !parsed_response["choices"].empty?
+          raise Error,
+                "PerplexityAI: No choices found in response"
+        end
 
-        choices.map { |c| c.dig("message", "content") }.join("\n").strip
+        # Return the full parsed JSON response (Hash) as expected by the base Engine class
+        parsed_response
       end
     end
 

data/lib/boxcars/engine.rb

@@ -70,7 +70,7 @@ module Boxcars
             raise TypeError, "Expected Hash from client method, got #{api_response_hash.class}: #{api_response_hash.inspect}"
           end
 
-          check_response(api_response_hash)
+          validate_response!(api_response_hash)
 
           current_choices = api_response_hash["choices"]
           if current_choices.is_a?(Array)
@@ -108,6 +108,34 @@ module Boxcars
         response["output"] || response.to_s
       end
     end
+
+    # Validate API response and raise appropriate errors
+    # @param response [Hash] The response to validate.
+    # @param must_haves [Array<String>] The keys that must be in the response.
+    # @raise [KeyError] if there is an issue with the API key.
+    # @raise [Boxcars::Error] if the response is not valid.
+    def validate_response!(response, must_haves: %w[choices])
+      # Check for API errors first
+      if response['error']
+        error_details = response['error']
+        raise Boxcars::Error, "API error: #{error_details}" unless error_details.is_a?(Hash)
+
+        code = error_details['code']
+        message = error_details['message'] || 'unknown error'
+
+        # Handle common API key errors
+        raise KeyError, "API key not valid or permission denied" if ['invalid_api_key', 'permission_denied'].include?(code)
+
+        raise Boxcars::Error, "API error: #{message}"
+
+      end
+
+      # Check for required keys in response
+      has_required_content = must_haves.any? { |key| response.key?(key) && !response[key].nil? }
+      return if has_required_content
+
+      raise Boxcars::Error, "Response missing required keys. Expected one of: #{must_haves.join(', ')}"
+    end
   end
 end
 

data/lib/boxcars/version.rb

@@ -2,5 +2,5 @@
 
 module Boxcars
   # The current version of the gem.
-  VERSION = "0.8.6"
+  VERSION = "0.8.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Francis Sullivan