Module: OllamaChat::Information

Extended by:
Tins::Concern
Included in:
Chat
Defined in:
lib/ollama_chat/information.rb

Overview

A module that provides information and user agent functionality for OllamaChat

The Information module encapsulates methods for managing application identification, displaying version and configuration details, and handling command-line interface help messages. It includes user agent capabilities for HTTP requests and provides comprehensive information display features for chat sessions.

Examples:

Displaying application information

chat.info

Showing version details

chat.version

Displaying usage help

chat.usage

Defined Under Namespace

Modules: UserAgent

Instance Method Summary collapse

Instance Method Details

#collection_stats ⇒ nil

The collection_stats method displays statistics about the current document collection.

This method outputs information regarding the active document collection, including the collection name, total number of embeddings, and a list of tags.

Returns:

  • (nil) —

    This method always returns nil.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/ollama_chat/information.rb', line 66

def collection_stats
  STDOUT.puts <<~EOT
    Current Collection
      Name: #{bold{@documents.collection}}
      #Embeddings: #{@documents.size}
      #Tags: #{@documents.tags.size}
      Tags: #{@documents.tags}
  EOT
  nil
end

#display_chat_help ⇒ nil

The display_chat_help method outputs the chat help message to standard output.

Returns:

  • (nil) —

    This method always returns nil after printing the help message.



166
167
168
169
 
# File 'lib/ollama_chat/information.rb', line 166

def display_chat_help
  STDOUT.puts display_chat_help_message
  nil
end

#info ⇒ nil

The info method displays comprehensive information about the current state of the ollama_chat instance. This includes version details, server connection status, model configurations, embedding settings, and various operational switches.

Returns:

  • (nil) —

    This method does not return a value; it outputs information directly to standard output.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ollama_chat/information.rb', line 84

def info
  STDOUT.puts "Running ollama_chat version: #{bold(OllamaChat::VERSION)}"
  STDOUT.puts "Connected to ollama server version: #{bold(server_version)} on: #{bold(server_url)}"
  STDOUT.puts "Current conversation model is #{bold{@model}}."
  if @model_options.present?
    STDOUT.puts "  Options: #{JSON.pretty_generate(@model_options).gsub(/(?<!\A)^/, '  ')}"
  end
  @embedding.show
  if @embedding.on?
    STDOUT.puts "Current embedding model is #{bold{@embedding_model}}"
    if @embedding_model_options.present?
      STDOUT.puts "  Options: #{JSON.pretty_generate(@embedding_model_options).gsub(/(?<!\A)^/, '  ')}"
    end
    STDOUT.puts "Text splitter is #{bold{config.embedding.splitter.name}}."
    collection_stats
  end
  markdown.show
  stream.show
  think_mode.show
  think_loud.show
  location.show
  voice.show
  @voice.on? and @voices.show
  tools_support.show
  STDOUT.puts "Documents database cache is #{@documents.nil? ? 'n/a' : bold{@documents.cache.class}}"
  STDOUT.puts "Document policy for references in user text: #{bold{document_policy}}"
  STDOUT.puts "Currently selected search engine is #{bold(search_engine)}."
  STDOUT.puts "Conversation length: #{bold(@messages.size.to_s)} message(s)."
  nil
end

#server_url ⇒ String

The server_url method returns the base URL of the Ollama server connection.

Returns:

  • (String) —

    the base URL used for communicating with the Ollama API



217
218
219
 
# File 'lib/ollama_chat/information.rb', line 217

def server_url
  @server_url ||= ollama.base_url
end

#server_version ⇒ String

The server_version method retrieves the version of the Ollama server.

Returns:

  • (String) —

    the version string of the connected Ollama server



210
211
212
 
# File 'lib/ollama_chat/information.rb', line 210

def server_version
  @server_version ||= ollama.version.version
end

#usage ⇒ Integer

The usage method displays the command-line interface help text and returns an exit code of 0.

Returns:

  • (Integer) —

    always returns 0 indicating successful help display



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ollama_chat/information.rb', line 175

def usage
  STDOUT.puts <<~EOT
    Usage: #{progname} [OPTIONS]

      -f CONFIG      config file to read
      -u URL         the ollama base url, OLLAMA_URL
      -m MODEL       the ollama model to chat with, OLLAMA_CHAT_MODEL, ?selector
      -s SYSTEM      the system prompt to use as a file, OLLAMA_CHAT_SYSTEM, ?selector
      -c CHAT        a saved chat conversation to load
      -C COLLECTION  name of the collection used in this conversation
      -D DOCUMENT    load document and add to embeddings collection (multiple)
      -M             use (empty) MemoryCache for this chat session
      -E             disable embeddings for this chat session
      -S             open a socket to receive input from ollama_chat_send
      -V             display the current version number and quit
      -h             this help

      Use `?selector` with `-m` or `-s` to filter options. Multiple matches
      will open a chooser dialog.
  EOT
  0
end

#version ⇒ Integer

The version method outputs the program name and its version number to standard output.

Returns:

  • (Integer) —

    returns 0 indicating successful execution



202
203
204
205
 
# File 'lib/ollama_chat/information.rb', line 202

def version
  STDOUT.puts "%s %s" % [ progname, OllamaChat::VERSION ]
  0
end