Module: OllamaChat::Information

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

Defined Under Namespace

Modules: UserAgent

Instance Method Summary collapse

Instance Method Details

#collection_statsObject



19
20
21
22
23
24
25
26
27
28
# File 'lib/ollama_chat/information.rb', line 19

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_helpObject



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/ollama_chat/information.rb', line 61

def display_chat_help
  STDOUT.puts <<~EOT
    /copy                           to copy last response to clipboard
    /paste                          to paste content
    /markdown                       toggle markdown output
    /stream                         toggle stream output
    /location                       toggle location submission
    /voice [change]                 toggle voice output or change the voice
    /list [n]                       list the last n / all conversation exchanges
    /clear [what]                   clear what=messages|links|history|tags|all
    /clobber                        clear the conversation, links, and collection
    /drop [n]                       drop the last n exchanges, defaults to 1
    /model                          change the model
    /system [show]                  change/show system prompt
    /regenerate                     the last answer message
    /collection [clear|change]      change (default) collection or clear
    /info                           show information for current session
    /config                         output current configuration (#{@ollama_chat_config.filename.to_s.inspect})
    /document_policy                pick a scan policy for document references
    /think                          enable ollama think setting for models
    /import source                  import the source's content
    /summarize [n] source           summarize the source's content in n words
    /embedding                      toggle embedding paused or not
    /embed source                   embed the source's content
    /web [n] query                  query web search & return n or 1 results
    /links [clear]                  display (or clear) links used in the chat
    /save filename                  store conversation messages
    /load filename                  load conversation messages
    /quit                           to quit
    /help                           to view this help
  EOT
  nil
end

#infoObject



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/ollama_chat/information.rb', line 30

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.show
  location.show
  voice.show
  if @voice.on?
    STDOUT.puts "  Using voice #{bold{@current_voice}} to speak."
  end
  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_urlObject



127
128
129
# File 'lib/ollama_chat/information.rb', line 127

def server_url
  @server_url ||= ollama.base_url
end

#server_versionObject



123
124
125
# File 'lib/ollama_chat/information.rb', line 123

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

#usageObject



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/ollama_chat/information.rb', line 95

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

#versionObject



118
119
120
121
# File 'lib/ollama_chat/information.rb', line 118

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