Module: LLM::Sequel::Plugin::InstanceMethods

Defined in:
lib/llm/sequel/plugin.rb

Constant Summary collapse

Utils =
Plugin::Utils

Instance Method Summary collapse

Instance Method Details

#callObject

Calls into the stored context.

Returns:

See Also:



189
190
191
# File 'lib/llm/sequel/plugin.rb', line 189

def call(...)
  ctx.call(...)
end

#context_windowInteger

Returns:

  • (Integer)

See Also:



240
241
242
243
244
# File 'lib/llm/sequel/plugin.rb', line 240

def context_window
  ctx.context_window
rescue LLM::NoSuchModelError, LLM::NoSuchRegistryError
  0
end

#costLLM::Cost

Returns:

See Also:



233
234
235
# File 'lib/llm/sequel/plugin.rb', line 233

def cost
  ctx.cost
end

#functionsArray<LLM::Function>

Returns:

See Also:



219
220
221
# File 'lib/llm/sequel/plugin.rb', line 219

def functions
  ctx.functions
end

#image_urlLLM::Object

Returns:

See Also:



277
278
279
# File 'lib/llm/sequel/plugin.rb', line 277

def image_url(...)
  ctx.image_url(...)
end

#interrupt!nil Also known as: cancel!

Returns:

  • (nil)

See Also:



261
262
263
# File 'lib/llm/sequel/plugin.rb', line 261

def interrupt!
  ctx.interrupt!
end

#llmLLM::Provider

Returns the resolved provider instance for this record.

Returns:



305
306
307
308
309
310
311
312
313
314
# File 'lib/llm/sequel/plugin.rb', line 305

def llm
  options = self.class.llm_plugin_options
  columns = Utils.columns(options)
  provider = self[columns[:provider_column]]
  kwargs = Utils.resolve_options(self, options[:provider], Plugin::EMPTY_HASH)
  return @llm if @llm
  @llm = LLM.method(provider).call(**kwargs)
  @llm.tracer = Utils.resolve_option(self, options[:tracer]) if options[:tracer]
  @llm
end

#local_fileLLM::Object

Returns:

See Also:



284
285
286
# File 'lib/llm/sequel/plugin.rb', line 284

def local_file(...)
  ctx.local_file(...)
end

#messagesArray<LLM::Message>

Returns:

See Also:



203
204
205
# File 'lib/llm/sequel/plugin.rb', line 203

def messages
  ctx.messages
end

#modeSymbol

Returns:

  • (Symbol)

See Also:



196
197
198
# File 'lib/llm/sequel/plugin.rb', line 196

def mode
  ctx.mode
end

#model!String

Note:

The bang is used because Sequel reserves ‘model` for the underlying model class on instances.

Returns:

  • (String)

See Also:



212
213
214
# File 'lib/llm/sequel/plugin.rb', line 212

def model!
  ctx.model
end

#promptLLM::Prompt Also known as: build_prompt

Returns:

See Also:



269
270
271
# File 'lib/llm/sequel/plugin.rb', line 269

def prompt(&)
  ctx.prompt(&)
end

#remote_fileLLM::Object

Returns:

See Also:



291
292
293
# File 'lib/llm/sequel/plugin.rb', line 291

def remote_file(...)
  ctx.remote_file(...)
end

#respondLLM::Response

Continues the stored context through the Responses API and flushes it.

Returns:

See Also:



172
173
174
175
# File 'lib/llm/sequel/plugin.rb', line 172

def respond(...)
  options = self.class.llm_plugin_options
  ctx.respond(...).tap { Utils.save(self, ctx, options) }
end

#returnsArray<LLM::Function::Return>

Returns:

See Also:



226
227
228
# File 'lib/llm/sequel/plugin.rb', line 226

def returns
  ctx.returns
end

#talkLLM::Response

Continues the stored context with new input and flushes it.

Returns:

See Also:



163
164
165
166
# File 'lib/llm/sequel/plugin.rb', line 163

def talk(...)
  options = self.class.llm_plugin_options
  ctx.talk(...).tap { Utils.save(self, ctx, options) }
end

#tracerLLM::Tracer

Returns:

See Also:



298
299
300
# File 'lib/llm/sequel/plugin.rb', line 298

def tracer
  ctx.tracer
end

#usageLLM::Object

Returns usage from the mapped usage columns.

Returns:



249
250
251
252
253
254
255
256
# File 'lib/llm/sequel/plugin.rb', line 249

def usage
  columns = Utils.columns(self.class.llm_plugin_options)
  LLM::Object.from(
    input_tokens: self[columns[:input_tokens]] || 0,
    output_tokens: self[columns[:output_tokens]] || 0,
    total_tokens: self[columns[:total_tokens]] || 0
  )
end

#waitArray<LLM::Function::Return>

Waits for queued tool work to finish.

Returns:

See Also:



181
182
183
# File 'lib/llm/sequel/plugin.rb', line 181

def wait(...)
  ctx.wait(...)
end