Class: Boxcars::Ollama

Inherits:
Engine
  • Object
show all
Includes:
OpenAICompatibleChatHelpers, UnifiedObservability
Defined in:
lib/boxcars/engine/ollama.rb

Overview

An engine that uses a local Ollama API (OpenAI-compatible).

Constant Summary collapse

DEFAULT_PARAMS = 
{
  model: "llama3",
  temperature: 0.1,
  max_tokens: 4096
}.freeze
DEFAULT_URI_BASE = 
"http://localhost:11434/v1"
DEFAULT_NAME = 
"Ollama engine"
DEFAULT_DESCRIPTION = 
"useful for when you need to use local AI to answer questions. " \
"You should ask targeted questions"

Instance Attribute Summary collapse

Attributes inherited from Engine

#batch_size, #user_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Engine

#add_usage_detail!, #aggregate_generate_usage!, #aggregate_token_usage_details!, #append_generate_choices!, #capabilities, #extract_answer, #generate, #generate_one, #generation_info, #get_num_tokens, #normalize_generate_response, #process_generate_prompt!, #process_generate_response!, #run, #supports?, #usage_nested_token_value, #usage_token_value, #validate_response!

Constructor Details

#initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, batch_size: 2, uri_base: DEFAULT_URI_BASE, **kwargs) ⇒ Ollama

Returns a new instance of Ollama.

Parameters:

  • uri_base (String) (defaults to: DEFAULT_URI_BASE) —

    Base URL for the Ollama API (default: localhost:11434/v1).

Raises:



24
25
26
27
28
29
30
31
 
# File 'lib/boxcars/engine/ollama.rb', line 24

def initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, batch_size: 2, uri_base: DEFAULT_URI_BASE, **kwargs)
  raise ArgumentError, "unknown keyword: :prompts" if kwargs.key?(:prompts)

  @uri_base = uri_base
  user_id = kwargs.delete(:user_id)
  @ollama_params = DEFAULT_PARAMS.merge(kwargs)
  super(description:, name:, batch_size:, user_id:)
end

Instance Attribute Details

#ollama_params ⇒ Object (readonly)

Returns the value of attribute ollama_params.



11
12
13
 
# File 'lib/boxcars/engine/ollama.rb', line 11

def ollama_params
  @ollama_params
end

#uri_base ⇒ Object (readonly)

Returns the value of attribute uri_base.



11
12
13
 
# File 'lib/boxcars/engine/ollama.rb', line 11

def uri_base
  @uri_base
end

Class Method Details

.provider_client(uri_base: DEFAULT_URI_BASE) ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/boxcars/engine/ollama.rb', line 33

def self.provider_client(uri_base: DEFAULT_URI_BASE)
  # The OpenAI client expects an API key even for local endpoints.
  Boxcars::OpenAIClient.build(
    access_token: "ollama-dummy-key",
    uri_base: uri_base
  )
end

Instance Method Details

#client(prompt:, inputs: {}, **kwargs) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/boxcars/engine/ollama.rb', line 41

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 = @ollama_params.merge(kwargs)
  current_prompt_object = prompt
  api_request_params = nil

  begin
    clnt = self.class.provider_client(uri_base: @uri_base)
    api_request_params = prepare_openai_compatible_chat_request(current_prompt_object, inputs, current_params)

    log_messages_debug(api_request_params[:messages]) if Boxcars.configuration.log_prompts && api_request_params[:messages]

    execute_openai_compatible_chat_call(
      client: clnt,
      api_request_params: api_request_params,
      response_data: response_data,
      success_check: ->(raw) { raw[:choices] },
      unknown_error_message: "Unknown Ollama API Error",
      error_class: Error
    )
  rescue StandardError => e
    handle_openai_compatible_standard_error(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),
      user_id:
    }
    track_ai_generation(
      duration_ms:,
      current_params:,
      request_context:,
      response_data:,
      provider: :ollama
    )
  end

  ollama_handle_call_outcome(response_data:)
end

#default_params ⇒ Object 



84
85
86
 
# File 'lib/boxcars/engine/ollama.rb', line 84

def default_params
  @ollama_params
end