Module: OllamaChat::Switches

Included in:
Chat
Defined in:
lib/ollama_chat/switches.rb

Overview

A module that provides switch functionality for configuring application behavior.

The Switches module encapsulates various toggle switches used throughout the OllamaChat application to control different features and settings such as streaming, thinking, markdown output, voice output, embedding, and location information. These switches allow users to dynamically enable or disable specific functionalities during a chat session.

Examples:

Toggling a switch on/off

switch = OllamaChat::Switches::Switch.new(value: false, msg: { true => 'Enabled', false => 'Disabled' })
switch.toggle  # Turns the switch on
switch.toggle  # Turns the switch off

Defined Under Namespace

Modules: CheckSwitch Classes: CombinedSwitch, Switch

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#embedding ⇒ OllamaChat::Switches::CombinedSwitch (readonly)

The embedding attribute reader returns the embedding switch object.

Returns:



156
157
158
 
# File 'lib/ollama_chat/switches.rb', line 156

def embedding
  @embedding
end

#embedding_enabled ⇒ OllamaChat::Switches::Switch (readonly)

The embedding_enabled reader returns the embedding enabled switch instance.

Returns:



162
163
164
 
# File 'lib/ollama_chat/switches.rb', line 162

def embedding_enabled
  @embedding_enabled
end

#embedding_paused ⇒ OllamaChat::Switches::Switch (readonly)

The embedding_paused method returns the current state of the embedding pause flag.

Returns:



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

def embedding_paused
  @embedding_paused
end

#location ⇒ OllamaChat::Switches::Switch (readonly)

The location method returns the current location setting.

Returns:



172
173
174
 
# File 'lib/ollama_chat/switches.rb', line 172

def location
  @location
end

#markdown ⇒ OllamaChat::Switches::Switch (readonly)

The markdown attribute reader returns the markdown switch object. The voice reader returns the voice switch instance.

Returns:



140
141
142
 
# File 'lib/ollama_chat/switches.rb', line 140

def markdown
  @markdown
end

#runtime_info ⇒ Object (readonly)

Provides access to the runtime_info switch controlling the visibility of runtime information in the chat



179
180
181
 
# File 'lib/ollama_chat/switches.rb', line 179

def runtime_info
  @runtime_info
end

#stream ⇒ OllamaChat::Switches::Switch (readonly)

The think method returns the current state of the stream switch.

Returns:



134
135
136
 
# File 'lib/ollama_chat/switches.rb', line 134

def stream
  @stream
end

#think_loud ⇒ OllamaChat::Switches::Switch (readonly)

The think_loud method returns the current state of the think loud switch.

Returns:



145
146
147
 
# File 'lib/ollama_chat/switches.rb', line 145

def think_loud
  @think_loud
end

#tools_support ⇒ OllamaChat::Switch (readonly)

Switch tools support on/off (off → skip all, on → honour per‑tool state)

Returns:

  • (OllamaChat::Switch) —

    the tools_support setting object



184
185
186
 
# File 'lib/ollama_chat/switches.rb', line 184

def tools_support
  @tools_support
end

#voice ⇒ OllamaChat::Switches::Switch (readonly)

The voice reader returns the voice switch instance.

Returns:



150
151
152
 
# File 'lib/ollama_chat/switches.rb', line 150

def voice
  @voice
end

Instance Method Details

#setup_switches(config) ⇒ Object

The setup_switches method initializes various switches for configuring the application’s behavior.

This method creates and configures multiple switch objects that control different aspects of the application, such as streaming, thinking, markdown output, voice output, embedding, and location settings.

Parameters:

  • config (ComplexConfig::Settings) —

    the configuration object containing settings for the switches



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ollama_chat/switches.rb', line 195

def setup_switches(config)
  @stream = Switch.new(
    value: config.stream,
    msg: {
      true  => "Streaming enabled.",
      false => "Streaming disabled.",
    }
  )

  @think_loud = Switch.new(
    value: config.think.loud,
    msg: {
      true  => "Thinking out loud, show thinking annotations.",
      false => "Thinking silently, don't show thinking annotations.",
    }
  )

  @markdown = Switch.new(
    value: config.markdown,
    msg: {
      true  => "Using #{italic{'ANSI'}} markdown to output content.",
      false => "Using plaintext for outputting content.",
    }
  )

  @voice = Switch.new(
    value: config.voice.enabled,
    msg: {
      true  => "Voice output enabled.",
      false => "Voice output disabled.",
    }
  )

  @embedding_enabled = Switch.new(
    value: config.embedding.enabled,
    msg: {
      true  => "Embedding enabled.",
      false => "Embedding disabled.",
    }
  )

  @embedding_paused = Switch.new(
    value: config.embedding.paused,
    msg: {
      true  => "Embedding paused.",
      false => "Embedding resumed.",
    }
  )

  @embedding = CombinedSwitch.new(
    value: -> { @embedding_enabled.on? && @embedding_paused.off? },
    msg: {
      true  => "Embedding is currently performed.",
      false => "Embedding is currently not performed.",
    }
  )

  @location = Switch.new(
    value: config.location.enabled,
    msg: {
      true  => "Location enabled.",
      false => "Location disabled.",
    }
  )

  @runtime_info = Switch.new(
    value: config.runtime_info.enabled,
    msg: {
      true  => "Runtime Information enabled.",
      false => "Runtime Information disabled.",
    }
  )
  @tools_support = Switch.new(
    value: config.tools.enabled,
    msg: {
      true  => "Tools support enabled.",
      false => "Tools support disabled.",
    }
  )
end