prescient 0.6.0 → 0.8.0

data/lib/prescient/provider/ollama.rb

@@ -1,183 +1,186 @@
 # frozen_string_literal: true
 
-require 'httparty'
-
-# Ollama local or hosted API provider adapter.
-class Prescient::Provider::Ollama < Prescient::Base
-  include HTTParty
-
-  def initialize(**options)
-    super
-    self.class.base_uri(@options[:url])
-    self.class.default_timeout(@options[:timeout] || 60)
-  end
-
-  # Generate an embedding through Ollama's `/api/embed` endpoint.
-  # @param text [String] Text to embed
-  # @return [Array<Float>] Embedding vector from the first returned input item
-  def generate_embedding(text, **_options)
-    handle_errors do
-      embeddings = fetch_and_parse('post', '/api/embed',
-                                   root_key: 'embeddings',
-                                   headers:  { 'Content-Type' => 'application/json' },
-                                   body:     {
-                                     model: options[:model] || @options[:embedding_model],
-                                     input: clean_text(text),
-                                   }.to_json)
-
-      embedding = embeddings.is_a?(Array) ? embeddings.first : nil # : Array[Float]?
-      raise Prescient::InvalidResponseError, 'No embedding returned' unless embedding.is_a?(Array)
-
-      expected_dimensions = @options[:embedding_dimensions]
-      if expected_dimensions && embedding.length != expected_dimensions
-        raise Prescient::InvalidResponseError,
-              "Invalid embedding dimensions: expected #{expected_dimensions}, got #{embedding.length}"
+require "httparty"
+
+module Prescient
+  module Provider
+    # Ollama local or hosted API provider adapter.
+    class Ollama < Prescient::Base
+      include HTTParty
+
+      def initialize(**options)
+        super
+        self.class.base_uri(@options[:url])
+        self.class.default_timeout(@options[:timeout] || 60)
       end
 
-      embedding
-    end
-  end
+      # Generate an embedding through Ollama's `/api/embed` endpoint.
+      # @param text [String] Text to embed
+      # @return [Array<Float>] Embedding vector from the first returned input item
+      def generate_embedding(text, **_options)
+        handle_errors do
+          embeddings = fetch_and_parse("post", "/api/embed",
+                                       root_key: "embeddings",
+                                       headers: { "Content-Type" => "application/json" },
+                                       body: {
+                                         model: options[:model] || @options[:embedding_model],
+                                         input: clean_text(text)
+                                       }.to_json)
+
+          embedding = embeddings.is_a?(Array) ? embeddings.first : nil # : Array[Float]?
+          raise Prescient::InvalidResponseError, "No embedding returned" unless embedding.is_a?(Array)
+
+          expected_dimensions = @options[:embedding_dimensions]
+          if expected_dimensions && embedding.length != expected_dimensions
+            raise Prescient::InvalidResponseError,
+                  "Invalid embedding dimensions: expected #{expected_dimensions}, got #{embedding.length}"
+          end
+
+          embedding
+        end
+      end
 
-  # Generate text through Ollama's generation endpoint.
-  # @param prompt [String] Prompt to send
-  # @param context_items [Array<Hash, String>] Optional context items
-  # @return [Hash] Normalized response data
-  def generate_response(prompt, context_items = [], **options)
-    handle_errors do
-      request_options = prepare_generate_response(prompt, context_items, **options)
-
-      # Make the request and store both text and full response
-      response = self.class.post('/api/generate', **request_options)
-      validate_response!(response, 'POST /api/generate')
-
-      generated_text = response.parsed_response['response']
-      raise Prescient::InvalidResponseError, 'No response generated' unless generated_text
-
-      {
-        response:        generated_text.strip,
-        model:           options[:model] || @options[:chat_model],
-        provider:        'ollama',
-        processing_time: response.parsed_response['total_duration']&./(1_000_000_000.0),
-        metadata:        {
-          eval_count:        response.parsed_response['eval_count'],
-          eval_duration:     response.parsed_response['eval_duration'],
-          prompt_eval_count: response.parsed_response['prompt_eval_count'],
-        },
-      }
-    end
-  end
+      # Generate text through Ollama's generation endpoint.
+      # @param prompt [String] Prompt to send
+      # @param context_items [Array<Hash, String>] Optional context items
+      # @return [Hash] Normalized response data
+      def generate_response(prompt, context_items = [], **options)
+        handle_errors do
+          request_options = prepare_generate_response(prompt, context_items, **options)
+
+          # Make the request and store both text and full response
+          response = self.class.post("/api/generate", **request_options)
+          validate_response!(response, "POST /api/generate")
+
+          generated_text = response.parsed_response["response"]
+          raise Prescient::InvalidResponseError, "No response generated" unless generated_text
+
+          {
+            response: generated_text.strip,
+            model: options[:model] || @options[:chat_model],
+            provider: "ollama",
+            processing_time: response.parsed_response["total_duration"]&./(1_000_000_000.0),
+            metadata: {
+              eval_count: response.parsed_response["eval_count"],
+              eval_duration: response.parsed_response["eval_duration"],
+              prompt_eval_count: response.parsed_response["prompt_eval_count"]
+            }
+          }
+        end
+      end
 
-  # Check whether the configured Ollama models are available locally.
-  #
-  # `reachable` indicates the Ollama API answered successfully. `ready`
-  # indicates that both configured models are present in the local model list.
-  #
-  # @return [Hash] Provider health information
-  def health_check
-    handle_errors do
-      models = available_models
-      embedding_available = models.any? { |m| m[:embedding] }
-      chat_available = models.any? { |m| m[:chat] }
-
-      {
-        status:           'healthy',
-        provider:         'ollama',
-        reachable:        true,
-        url:              @options[:url],
-        models_available: models.map { |m| m[:name] },
-        embedding_model:  {
-          name:      @options[:embedding_model],
-          available: embedding_available,
-        },
-        chat_model:       {
-          name:      @options[:chat_model],
-          available: chat_available,
-        },
-        ready:            embedding_available && chat_available,
-      }
-    end
-  rescue Prescient::Error => e
-    {
-      status:    'unavailable',
-      provider:  'ollama',
-      reachable: false,
-      error:     e.class.name,
-      message:   e.message,
-      url:       @options[:url],
-      ready:     false,
-    }
-  end
+      # Check whether the configured Ollama models are available locally.
+      #
+      # `reachable` indicates the Ollama API answered successfully. `ready`
+      # indicates that both configured models are present in the local model list.
+      #
+      # @return [Hash] Provider health information
+      def health_check
+        handle_errors do
+          models = available_models
+          embedding_available = models.any? { |m| m[:embedding] }
+          chat_available = models.any? { |m| m[:chat] }
+
+          {
+            status: "healthy",
+            provider: "ollama",
+            reachable: true,
+            url: @options[:url],
+            models_available: models.map { |m| m[:name] },
+            embedding_model: {
+              name: @options[:embedding_model],
+              available: embedding_available
+            },
+            chat_model: {
+              name: @options[:chat_model],
+              available: chat_available
+            },
+            ready: embedding_available && chat_available
+          }
+        end
+      rescue Prescient::Error => e
+        {
+          status: "unavailable",
+          provider: "ollama",
+          reachable: false,
+          error: e.class.name,
+          message: e.message,
+          url: @options[:url],
+          ready: false
+        }
+      end
 
-  # List models currently available from Ollama.
-  # @return [Array<Hash>] Model descriptors including name, size, digest,
-  #   modified_at, and booleans for configured embedding/chat roles
-  def available_models
-    return @_available_models if defined?(@_available_models)
-
-    handle_errors do
-      @_available_models = (fetch_and_parse('get', '/api/tags', root_key: 'models') || []).map { |model|
-        { embedding:  model['name'] == @options[:embedding_model],
-          chat:       model['name'] == @options[:chat_model],
-          name: model['name'], size: model['size'], modified_at: model['modified_at'], digest: model['digest'] }
-      }
-    end
-  end
+      # List models currently available from Ollama.
+      # @return [Array<Hash>] Model descriptors including name, size, digest,
+      #   modified_at, and booleans for configured embedding/chat roles
+      def available_models
+        return @_available_models if defined?(@_available_models)
+
+        handle_errors do
+          @_available_models = (fetch_and_parse("get", "/api/tags", root_key: "models") || []).map do |model|
+            { embedding: model["name"] == @options[:embedding_model],
+              chat: model["name"] == @options[:chat_model],
+              name: model["name"], size: model["size"], modified_at: model["modified_at"], digest: model["digest"] }
+          end
+        end
+      end
 
-  # Pull a model into the Ollama installation.
-  # @param model_name [String] Model identifier to download
-  # @return [Hash] Pull result
-  def pull_model(model_name)
-    handle_errors do
-      fetch_and_parse('post', '/api/pull',
-                      headers: { 'Content-Type' => 'application/json' },
-                      body:    { name: model_name }.to_json,
-                      timeout: 300) # 5 minutes for model download
-      {
-        success: true,
-        model:   model_name,
-        message: "Model #{model_name} pulled successfully",
-      }
-    end
-  end
+      # Pull a model into the Ollama installation.
+      # @param model_name [String] Model identifier to download
+      # @return [Hash] Pull result
+      def pull_model(model_name)
+        handle_errors do
+          fetch_and_parse("post", "/api/pull",
+                          headers: { "Content-Type" => "application/json" },
+                          body: { name: model_name }.to_json,
+                          timeout: 300) # 5 minutes for model download
+          {
+            success: true,
+            model: model_name,
+            message: "Model #{model_name} pulled successfully"
+          }
+        end
+      end
 
-  protected
+      protected
 
-  def validate_configuration!
-    required_options = [:url, :embedding_model, :chat_model]
-    missing_options = required_options.select { |opt| @options[opt].nil? }
+      def validate_configuration!
+        required_options = %i[url embedding_model chat_model]
+        missing_options = required_options.select { |opt| @options[opt].nil? }
 
-    return unless missing_options.any?
+        return unless missing_options.any?
 
-    raise Prescient::Error, "Missing required options: #{missing_options.join(', ')}"
-  end
+        raise Prescient::Error, "Missing required options: #{missing_options.join(", ")}"
+      end
 
-  private
-
-  def prepare_generate_response(prompt, context_items = [], **options)
-    formatted_prompt = build_prompt(prompt, context_items)
-    { root_key: 'response',
-      headers:  { 'Content-Type' => 'application/json' },
-      body:     {
-        model:   options[:model] || @options[:chat_model],
-        prompt:  formatted_prompt,
-        stream:  false,
-        options: {
-          num_predict: options[:max_tokens] || 2000,
-          temperature: options[:temperature] || 0.7,
-          top_p:       options[:top_p] || 0.9,
-        },
-      }.to_json }
-  end
+      private
+
+      def prepare_generate_response(prompt, context_items = [], **options)
+        formatted_prompt = build_prompt(prompt, context_items)
+        { root_key: "response",
+          headers: { "Content-Type" => "application/json" },
+          body: {
+            model: options[:model] || @options[:chat_model],
+            prompt: formatted_prompt,
+            stream: false,
+            options: {
+              num_predict: options[:max_tokens] || 2000,
+              temperature: options[:temperature] || 0.7,
+              top_p: options[:top_p] || 0.9
+            }
+          }.to_json }
+      end
 
-  def fetch_and_parse(htt_verb, endpoint, **options)
-    options = options.dup
-    root_key = options.delete(:root_key)
+      def fetch_and_parse(htt_verb, endpoint, **options)
+        options = options.dup
+        root_key = options.delete(:root_key)
 
-    response = self.class.send(htt_verb, endpoint, **options)
-    validate_response!(response, "#{htt_verb.upcase} #{endpoint}")
-    return unless root_key
+        response = self.class.send(htt_verb, endpoint, **options)
+        validate_response!(response, "#{htt_verb.upcase} #{endpoint}")
+        return unless root_key
 
-    response.parsed_response[root_key]
+        response.parsed_response[root_key]
+      end
+    end
   end
-
 end