Class: OllamaChat::FollowChat

Inherits:
Object
  • Object
show all
Includes:
Ollama, Ollama::Handlers::Concern, MessageFormat, Term::ANSIColor
Defined in:
lib/ollama_chat/follow_chat.rb

Overview

A class that handles chat responses and manages the flow of conversation between the user and Ollama models.

This class is responsible for processing Ollama API responses, updating message history, displaying formatted output to the terminal, and managing voice synthesis for spoken responses. It acts as a handler for streaming responses and ensures proper formatting and display of both regular content and thinking annotations.

Examples:

Processing a chat response

follow_chat = OllamaChat::FollowChat.new(chat: chat_instance, messages: message_list)
follow_chat.call(response)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MessageFormat

#message_type, #talk_annotate, #think_annotate

Constructor Details

#initialize(chat:, messages:, voice: nil, output: STDOUT) ⇒ OllamaChat::FollowChat

Initializes a new instance of OllamaChat::FollowChat.

conversation context. conversation history. should be printed. Defaults to STDOUT.

Parameters:

  • chat (OllamaChat::Chat) —

    The chat object, which represents the

  • messages (#to_a) —

    A collection of message objects, representing the

  • voice (String) (defaults to: nil) —

    (optional) to speek with if any.

  • output (IO) (defaults to: STDOUT) —

    (optional) The output stream where terminal output



30
31
32
33
34
35
36
37
 
# File 'lib/ollama_chat/follow_chat.rb', line 30

def initialize(chat:, messages:, voice: nil, output: STDOUT)
  super(output:)
  @chat        = chat
  @output.sync = true
  @say         = voice ? Handlers::Say.new(voice:) : NOP
  @messages    = messages
  @user        = nil
end

Instance Attribute Details

#messages ⇒ OllamaChat::MessageList<Ollama::Message> (readonly)

Returns the conversation history (an array of message objects).

the conversation.

Returns:



43
44
45
 
# File 'lib/ollama_chat/follow_chat.rb', line 43

def messages
  @messages
end

Instance Method Details

#call(response) ⇒ OllamaChat::FollowChat

Invokes the chat flow based on the provided Ollama server response.

The response is expected to be a parsed JSON object containing information about the user input and the assistant’s response.

If the response indicates an assistant message, this method:

1. Ensures that an assistant response exists in the message history (if
   not already present).
2. Updates the last message with the new content and thinking (if
   applicable).
3. Displays the formatted terminal output for the user.
4. Outputs the voice response (if configured).

Regardless of whether an assistant message is present, this method also outputs evaluation statistics (if applicable).

server.

Parameters:

  • response (Ollama::Response) —

    The parsed JSON response from the Ollama

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ollama_chat/follow_chat.rb', line 65

def call(response)
  debug_output(response)

  if response&.message&.role == 'assistant'
    ensure_assistant_response_exists
    update_last_message(response)
    if @chat.stream.on?
      display_formatted_terminal_output
    else
      if display_output
        display_formatted_terminal_output
      end
    end
    @say.call(response)
  end

  output_eval_stats(response)

  self
end

#debug_output(response) ⇒ Object (private)

The debug_output method conditionally outputs the response object using jj when debugging is enabled.

Parameters:

  • response (Object) —

    the response object to be outputted



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

def debug_output(response)
  @chat.debug and jj response
end

#display_formatted_terminal_output(output = nil) ⇒ Object (private)

The display_formatted_terminal_output method formats and outputs the terminal content by processing the last message’s content and thinking, then prints it to the output. It handles markdown parsing and annotation based on chat settings, and ensures proper formatting with clear screen and move home commands. The method takes into account whether markdown and thinking modes are enabled to determine how to process and display the content.



186
187
188
189
 
# File 'lib/ollama_chat/follow_chat.rb', line 186

def display_formatted_terminal_output(output = nil)
  output ||= @output
  output.print(*([ clear_screen, move_home, *last_message_with_user ].compact))
end

#display_output ⇒ nil, String (private)

The display_output method shows the last message in the conversation.

This method delegates to the messages object’s show_last method, which displays the most recent non-user message in the conversation history. It is typically used to provide feedback to the user about the last response from the assistant.

Returns:

  • (nil, String) —

    the pager command or nil if no paging was performed.



199
200
201
202
203
204
205
206
207
 
# File 'lib/ollama_chat/follow_chat.rb', line 199

def display_output
  @messages.use_pager do |output|
    if @chat.markdown.on?
      display_formatted_terminal_output(output)
    else
      output.print(*last_message_with_user)
    end
  end
end

#ensure_assistant_response_exists ⇒ Object (private)

The ensure_assistant_response_exists method ensures that the last message in the conversation is from the assistant role.

If the last message is not from an assistant, it adds a new assistant message with empty content and optionally includes thinking content if the chat’s think mode is enabled. It also updates the user display variable to reflect the assistant’s message type and styling.



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ollama_chat/follow_chat.rb', line 114

def ensure_assistant_response_exists
  if @messages&.last&.role != 'assistant'
    @messages << Message.new(
      role: 'assistant',
      content: '',
      thinking: ('' if @chat.think?)
    )
    @user = message_type(@messages.last.images) + " " +
      bold { color(111) { 'assistant:' } }
  end
end

#eval_stats(response) ⇒ String (private)

The eval_stats method processes response statistics and formats them into a colored, readable string output.

the evaluation process including durations, counts, and rates, styled with colors and formatting

Parameters:

  • response (Object) —

    the response object containing evaluation metrics

Returns:

  • (String) —

    a formatted string with statistical information about



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ollama_chat/follow_chat.rb', line 217

def eval_stats(response)
  eval_duration        = response.eval_duration / 1e9
  prompt_eval_duration = response.prompt_eval_duration / 1e9
  stats_text = {
    eval_duration:        Tins::Duration.new(eval_duration),
    eval_count:           response.eval_count.to_i,
    eval_rate:            bold { "%.2f t/s" % (response.eval_count.to_i / eval_duration) } + color(111),
    prompt_eval_duration: Tins::Duration.new(prompt_eval_duration),
    prompt_eval_count:    response.prompt_eval_count.to_i,
    prompt_eval_rate:     bold { "%.2f t/s" % (response.prompt_eval_count.to_i / prompt_eval_duration) } + color(111),
    total_duration:       Tins::Duration.new(response.total_duration / 1e9),
    load_duration:        Tins::Duration.new(response.load_duration / 1e9),
  }.map { _1 * ?= } * ' '
  '📊 ' + color(111) {
    Kramdown::ANSI::Width.wrap(stats_text, percentage: 90).gsub(/(?<!\A)^/, '   ')
  }
end

#last_message_with_user ⇒ Array (private)

The last_message_with_user method constructs a formatted message array by combining user information, newline characters, thinking annotations, and content for display in the terminal output.

Returns:

  • (Array) —

    an array containing the user identifier, newline character, thinking annotation (if present), and content formatted for terminal display



174
175
176
177
 
# File 'lib/ollama_chat/follow_chat.rb', line 174

def last_message_with_user
  content, thinking = prepare_last_message
  [ @user, ?\n, thinking, content ]
end

#output_eval_stats(response) ⇒ Object (private)

The output_eval_stats method outputs evaluation statistics to the specified output stream.

Parameters:

  • response (Object) —

    the response object containing evaluation data



239
240
241
242
 
# File 'lib/ollama_chat/follow_chat.rb', line 239

def output_eval_stats(response)
  response.done or return
  @output.puts "", "", eval_stats(response)
end

#prepare_last_message ⇒ Array<String, String>, Array<String, nil> (private)

The prepare_last_message method processes and formats content and thinking annotations for display.

This method prepares the final content and thinking text by applying appropriate formatting based on the chat’s markdown and think loud settings. It handles parsing of content through Kramdown::ANSI when markdown is enabled, and applies annotation formatting to both content and thinking text according to the chat’s configuration.

Returns:

  • (Array<String, String>) —

    an array containing the processed content and thinking text

  • (Array<String, nil>) —

    an array containing the processed content and nil if thinking is disabled



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/ollama_chat/follow_chat.rb', line 153

def prepare_last_message
  content, thinking = @messages.last.content, @messages.last.thinking
  if @chat.markdown.on?
    content = talk_annotate { truncate_for_terminal @chat.kramdown_ansi_parse(content) }
    if @chat.think_loud?
      thinking = think_annotate { truncate_for_terminal@chat.kramdown_ansi_parse(thinking) }
    end
  else
    content = talk_annotate { content }
    @chat.think? and thinking = think_annotate { thinking }
  end
  return content&.chomp, thinking&.chomp
end

#truncate_for_terminal(text, max_lines: Tins::Terminal.lines) ⇒ String (private)

The truncate_for_terminal method processes text to fit within a specified number of lines.

This method takes a text string and trims it to ensure it doesn’t exceed the maximum number of lines allowed for terminal display. If the text exceeds the limit, only the last N lines are retained where N equals the maximum lines parameter.

Parameters:

  • text (String) —

    the text content to be processed

  • max_lines (Integer) (defaults to: Tins::Terminal.lines) —

    the maximum number of lines allowed (defaults to terminal lines)

Returns:

  • (String) —

    the text truncated to fit within the specified line limit



100
101
102
103
104
105
 
# File 'lib/ollama_chat/follow_chat.rb', line 100

def truncate_for_terminal(text, max_lines: Tins::Terminal.lines)
  max_lines = max_lines.clamp(1..)
  lines = text.lines
  return text if lines.size <= max_lines
  lines[-max_lines..-1].join('')
end

#update_last_message(response) ⇒ Object (private)

The update_last_message method appends the content of a response to the last message in the conversation. It also appends thinking content to the last message if thinking is enabled and thinking content is present.

and thinking

Parameters:

  • response (Object) —

    the response object containing message content



132
133
134
135
136
137
 
# File 'lib/ollama_chat/follow_chat.rb', line 132

def update_last_message(response)
  @messages.last.content << response.message&.content
  if @chat.think_loud? and response_thinking = response.message&.thinking.full?
    @messages.last.thinking << response_thinking
  end
end