Class: OllamaChat::Chat

Inherits:
Object
  • Object
show all
Includes:
Clipboard, Commands, Compaction, ConfigHandling, Conversation, Dialog, DocumentCache, FavouritesManagement, FileEditing, HTTPHandling, History, Information, InputContent, KramdownANSI, LocationHandling, Logging, MessageEditing, MessageFormat, MessageOutput, ModelHandling, Pager, Parsing, PersonaeManagement, PromptHandling, PromptManagement, RAGHandling, ServerSocket, SessionManagement, SourceFetching, StateSelectors, Switches, SystemPromptManagement, ThinkControl, TokenEstimator, ToolCalling, Utils::Chooser, Utils::UTF8Converter, Utils::ValueFormatter, WebSearching, Term::ANSIColor, Tins::GO
Defined in:
lib/ollama_chat/chat.rb

Overview

A chat client for interacting with Ollama models through a terminal interface.

The Chat class provides a complete command-line interface for chatting with language models via the Ollama API. It handles configuration management, message history, document processing, web searching, and various interactive features including voice output, markdown rendering, and embedding capabilities.

Examples:

Initializing a chat session

chat = OllamaChat::Chat.new(argv: ['-m', 'llama3.1'])

Starting an interactive chat

chat.start

Constant Summary

Constants included from ThinkControl

ThinkControl::THINK_MODE_STATES

Constants included from Parsing

Parsing::DOCUMENT_POLICY_STATES

Instance Attribute Summary collapse

Attributes included from Utils::Chooser

#current_search_state Stores the

Attributes included from SessionManagement

#session

Attributes included from ToolCalling

#tool_call_results

Attributes included from StateSelectors

#context_format, #document_policy, #think_mode, #voices

Attributes included from Switches

#embedding, #embedding_enabled, #embedding_paused, #location, #markdown, #runtime_info, #stream, #think_loud, #think_strip, #tools_support, #voice

Instance Method Summary collapse

Methods included from Utils::UTF8Converter

#convert_to_utf8

Methods included from Utils::ValueFormatter

#format_bytes, #format_tokens

Methods included from Utils::Chooser

#choose_entry, #choose_with_state

Methods included from Compaction

#compact_ratio_tokens, #compact_with_retry, #summarize_for_compaction, tool_summary_line

Methods included from PromptManagement

#add_new_prompt, #all_prompts, #choose_and_delete_prompt, #choose_and_edit_prompt, #choose_prompt, #choose_prompt_context, #duplicate_prompt, #export_prompt, #import_prompt, #info_prompt, #list_prompts, #prepare_conversation_history, #prompt_sync, #rename_prompt, #reset_prompt_to_default, #suggest_prompts

Methods included from SystemPromptManagement

#all_system_prompts, #change_system_prompt, #current_system_prompt, #current_system_prompt_name, #model_default_system_prompt, #raw_system_prompt, #set_current_system_prompt, #setup_system_prompt

Methods included from PromptHandling

#delete_prompt, #each_prompt, #load_prompt_from_file, #prompt, #store_prompt, #write_prompt

Methods included from RAGHandling

#database_collection?, #switch_collection

Methods included from SessionManagement

#load_links_from_session, #store_links_in_session, #store_messages_in_session

Methods included from PersonaeManagement

#assistant, #default_persona_profile, #initial_persona_name

Methods included from ConfigHandling

#config, #run_syntax_check, #syntax_checker_for

Methods included from ToolCalling

#configured_tools, #default_enabled_tools, #disable_tool, #enable_tool, #enabled_tools, #list_tools, #tool_configured?, #tool_enabled?, #tool_function, #tool_paths_allowed, #tool_registered?, #tools

Methods included from LocationHandling

#location_data, #location_description, #location_description?

Methods included from InputContent

#file_set_each

Methods included from FileEditing

#determine_valid_output_filename, #edit_file, #edit_text, #edit_text_block, #perform_insert, #vim

Methods included from KramdownANSI

#configure_kramdown_ansi_styles, #kramdown_ansi_parse

Methods included from ServerSocket

create_socket_server, send_to_server_socket

Methods included from Pager

#use_pager

Methods included from MessageFormat

#chat, #display_sender, #message_type, #role_color, #role_template, #sender_name_displayed, #talk_annotate, #think_annotate

Methods included from Clipboard

#perform_copy_to_clipboard, #perform_paste_from_clipboard

Methods included from MessageOutput

#output, #pipe

Methods included from Information

#client, #collection_descriptions, #collection_stats, #context_filled, #context_gauge, #context_usage, #conversation_length, #current_context_length, #display_chat_help, #dynamic_runtime_information, #dynamic_runtime_information_values, #info, #info_model, #info_rag, #info_runtime, #info_session, #infobar_message, #print_welcome, #server_url, #server_version, #static_runtime_information, #static_runtime_information_values, #usage, #user, #user_name, #version

Methods included from ThinkControl

#think, #think?, #think_loud?

Methods included from Dialog

#ask?, #confirm?

Methods included from WebSearching

#manage_links, #search_web, #web

Methods included from SourceFetching

#add_image, #embed, #embed_source, #fetch_source, #import, #import_source, #summarize, #summarize_source

Methods included from Parsing

#epub_read, #parse_atom, #parse_content, #parse_png, #parse_rss, #parse_source, #pdf_read, #personalize_character_profile, #ps_read, #reverse_markdown

Methods included from Utils::AnalyzeDirectory

#generate_structure

Methods included from ModelHandling

#get_stored_model_options

Methods included from StateSelectors

#setup_state_selectors

Methods included from Switches

#setup_switches

Methods included from Logging

#log, #logger

Methods included from Commands

#collection, #compose, #config, #copy, #list, #pipe, #reconnect, #session

Methods included from HTTPHandling

#get_url, #http_options, #links

Methods included from TokenEstimator

estimate

Constructor Details

#initialize(argv: ARGV.dup) ⇒ Chat

Initializes a new OllamaChat::Chat instance with the given command-line arguments.

Sets up the chat environment including configuration parsing, Ollama client initialization, model selection, system prompt handling, document processing setup, and history management. This method handles all the bootstrapping necessary to create a functional chat session that can communicate with an Ollama server and process various input types including text, documents, web content, and images.

The initialization process includes parsing command-line options using Tins::GO for robust argument handling, setting up the Ollama client with configurable timeouts (connect, read, write), validating Ollama API version compatibility (requires >= 0.9.0 for features used), configuring model selection based on command-line or configuration defaults, initializing system prompts from files or inline content, setting up document processing pipeline with embedding capabilities through Documentrix::Documents, creating message history management through OllamaChat::MessageList, initializing cache systems for document embeddings, setting up voice support and image handling for multimodal interactions, enabling optional server socket functionality for remote input, and handling configuration errors with interactive recovery mechanisms.

Parameters:

  • argv (Array<String>) (defaults to: ARGV.dup) —

    Command-line arguments to parse (defaults to ARGV.dup)

Raises:

  • (RuntimeError) —

    If the Ollama API version is less than 0.9.0, indicating incompatibility with required API features



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/ollama_chat/chat.rb', line 104

def initialize(argv: ARGV.dup)
  @opts               = go 'f:u:m:l:nSVh', argv
  @opts[?h] and exit usage
  @opts[?V] and exit version
  @ollama_chat_config = OllamaChat::OllamaChatConfig.new(@opts[?f])
  self.config         = @ollama_chat_config.config
  truncate_logs
  @messages           = OllamaChat::MessageList.new(self)
  OllamaChat::Database.setup_models.each { _1.ask_and_send(:seed, self) }
  setup_switches
  setup_session
  setup_state_selectors(config)
  connect_ollama
  @documents = setup_documents
  models::Collection.sync(self)
  @cache                = setup_cache
  @images               = []
  @kramdown_ansi_styles = configure_kramdown_ansi_styles
  @tool_call_results    = Hash.new { |h, name| h[name] = [] }
  setup_personae_directory
  @opts[?S] and init_server_socket
rescue ComplexConfig::AttributeMissing, ComplexConfig::ConfigurationSyntaxError => e
  fix_config(e)
end

Instance Attribute Details

#cache ⇒ OllamaChat::RedisCache? (readonly)

Provides read-only access to the cache instance used by the object.

Returns:



163
164
165
 
# File 'lib/ollama_chat/chat.rb', line 163

def cache
  @cache
end

#documents ⇒ Documentrix::Documents (readonly)

Returns the documents set for this object, initializing it lazily if needed.

The documents set is memoized, meaning it will only be created once per object instance and subsequent calls will return the same Documentrix::Documents instance.

Returns:

  • (Documentrix::Documents) —

    A Documentrix::Documents object containing all documents associated with this instance



143
144
145
 
# File 'lib/ollama_chat/chat.rb', line 143

def documents
  @documents
end

#images ⇒ Array (readonly)

Returns the list of images currently queued for the next message.

Returns:

  • (Array) —

    a list of images to be sent with the next prompt



158
159
160
 
# File 'lib/ollama_chat/chat.rb', line 158

def images
  @images
end

#messages ⇒ OllamaChat::MessageList (readonly)

Returns the messages set for this object, initializing it lazily if needed.

The messages set is memoized, meaning it will only be created once per object instance and subsequent calls will return the same OllamaChat::MessageList instance.

Returns:



153
154
155
 
# File 'lib/ollama_chat/chat.rb', line 153

def messages
  @messages
end

#ollama ⇒ Ollama::Client (readonly)

The ollama reader returns the Ollama API client instance.

Returns:

  • (Ollama::Client) —

    the configured Ollama API client



132
133
134
 
# File 'lib/ollama_chat/chat.rb', line 132

def ollama
  @ollama
end

Instance Method Details

#debug ⇒ TrueClass, FalseClass

The debug method accesses the debug configuration setting.

Returns:

  • (TrueClass, FalseClass) —

    the current debug mode status



213
214
215
 
# File 'lib/ollama_chat/chat.rb', line 213

def debug
  OC::OLLAMA::CHAT::DEBUG
end

#generate(system: raw_system_prompt, prompt:, stream: false, think: false) ⇒ String

Sends a structured chat request to the Ollama model and returns the response content.

This method creates a minimal conversation consisting of a system message and a user message, executing it as a one-shot chat interaction.

Parameters:

  • system (String) (defaults to: raw_system_prompt) —

    the system prompt to guide the model's behavior (defaults to current raw_system_prompt)

  • prompt (String) —

    the user prompt to send to the model

  • stream (Boolean) (defaults to: false) —

    whether to stream the response (default: false)

  • think (Boolean) (defaults to: false) —

    enable thinking mode for hybrid-thinking models (default: false)

Returns:

  • (String) —

    the content of the resulting response message



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/ollama_chat/chat.rb', line 266

def generate(system: raw_system_prompt, prompt:, stream: false, think: false)
  messages = [
    OllamaChat::Message.new(
      role:        'system',
      content:     system,
    ),

    OllamaChat::Message.new(
      role: 'user',
      content: prompt
    ),
  ]

  content = call_ollama_chat(
    model:    @model,
    messages: ,
    options:  model_options,
    stream:   ,
    think:
  )&.message&.content.to_s

  if content.empty?
    log(:warn, "LLM generation returned empty content", data: { prompt: })
  else
    log(:info, "LLM generation successful", data: { prompt:, content: })
  end

  content
end

#initial_collection ⇒ Symbol

The initial_collection method determines the collection name to be used for embeddings in the RAG system.

Returns:

  • (Symbol) —

    the collection name symbol



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/ollama_chat/chat.rb', line 233

def initial_collection
  c = session&.current_collection.full? ||
    config.embedding.collection.full? ||
    'default'
  if c =~ /\A#{OllamaChat::COLLECTION_NAME_REGEXP.source}\z/
    c
  else
    'default'
  end.to_sym
end

#initial_model ⇒ String

Returns the model name to be used for the chat session.

The resolution priority is:

  1. The current session's model (if present).
  2. The model specified via the command line option -m.
  3. The default model name defined in the configuration.

Returns:

  • (String) —

    the model name to be used for the chat session



225
226
227
 
# File 'lib/ollama_chat/chat.rb', line 225

def initial_model
  session&.current_model.full? || @opts[?m].full? || config.model.name
end

#initial_system_prompt ⇒ String

The initial_system_prompt method returns the system prompt for the initial message.

Returns:

  • (String) —

    the system prompt for the initial message



248
249
250
 
# File 'lib/ollama_chat/chat.rb', line 248

def initial_system_prompt
  @messages.system_name
end

#inspect ⇒ String

Returns a human-readable string representation of the Chat object, including the class name and the base URL.

Returns:

  • (String) —

    the inspected string



300
301
302
 
# File 'lib/ollama_chat/chat.rb', line 300

def inspect
  "#<#{self.class}: #{base_url.to_s}>"
end

#start ⇒ Object

The start method initializes the chat session by displaying information, then prompts the user for input to begin interacting with the chat.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ollama_chat/chat.rb', line 182

def start
  log(:info, 'Starting chat client', data: {
    client:, server: { version: server_version, url: server_url }, user:,
    config: @ollama_chat_config.filename,
  })
  begin
    if model = session.current_model.full?
      use_model(model, keep_options: true)
    else
      use_model(initial_model)
    end
  rescue OllamaChat::UnknownModelError => e
    abort "Failed to use to model: #{e}"
  end

  STDOUT.puts

  setup_persona_from_session
  setup_system_prompt

  print_welcome
  info_session

  STDOUT.puts "\nType /help to display the chat help."

  interact_with_user
end

#voice_handler ⇒ Class, Array

Returns the voice handler class based on the configuration.

This method resolves the voice handler class specified in the config. If running within RSpec, it returns an empty array to avoid side effects.

Returns:

  • (Class, Array) —

    the voice handler class or an empty array if in test mode



172
173
174
175
176
177
178
 
# File 'lib/ollama_chat/chat.rb', line 172

def voice_handler
  defined?(RSpec) and return []
  case config.voice.handler
  when 'OllamaChat::Say'
    OllamaChat::Say
  end
end