Module: LLM::Sequel::Plugin

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

Overview

Sequel plugin for persisting LLM::Context state.

This plugin maps model columns onto provider selection, model selection, usage accounting, and serialized context data while leaving application-specific concerns such as credentials, associations, and UI shaping to the host app.

Context state can be stored as a JSON string (format: :string, the default) or as a structured object (format: :json / :jsonb) for databases such as PostgreSQL that can persist JSON natively. :json and :jsonb expect a real JSON column type with Sequel handling JSON typecasting for the model. provider:, context:, and tracer: can also be configured as symbols that are called on the model.

Defined Under Namespace

Modules: ClassMethods, InstanceMethods, Utils

Constant Summary collapse

EMPTY_HASH = 
{}.freeze
DEFAULTS = 
{
  data_column: :data,
  format: :string,
  tracer: nil,
  provider: nil,
  context: EMPTY_HASH
}.freeze

Class Method Summary collapse

Class Method Details

.apply(model) ⇒ void

This method returns an undefined value.

Called by Sequel when the plugin is first applied to a model class.

This hook installs the plugin's class- and instance-level behavior on the target model. It runs before configure, so it should only attach methods and not depend on per-model plugin options.

Parameters:

  • model (Class) 


114
115
116
117
 
# File 'lib/llm/sequel/plugin.rb', line 114

def self.apply(model, **)
  model.extend ClassMethods
  model.include InstanceMethods
end

.configure(model, options = EMPTY_HASH) ⇒ void

This method returns an undefined value.

Called by Sequel after apply with the options passed to plugin :llm, ....

This hook merges plugin defaults with the model's explicit settings and stores the resolved configuration on the model class for later use by instance methods such as LLM::Sequel::Plugin::InstanceMethods#llm and LLM::Sequel::Plugin::InstanceMethods#ctx.

Parameters:

  • model (Class)
  • options (Hash) (defaults to: EMPTY_HASH)

Options Hash (options):

  • :format (Symbol) —

    Storage format for the serialized context. Use :string for text columns, or :json / :jsonb for structured JSON columns with Sequel JSON typecasting enabled.

  • :tracer (Proc, Symbol, LLM::Tracer, nil) —

    Optional tracer, method name, or proc that resolves to one and is assigned through llm.tracer = ... on the resolved provider.

  • :provider (Proc, Symbol, LLM::Provider) —

    Must resolve to an LLM::Provider instance for the current record.



139
140
141
142
143
 
# File 'lib/llm/sequel/plugin.rb', line 139

def self.configure(model, options = EMPTY_HASH)
  options = DEFAULTS.merge(options)
  model.db.extension :pg_json if %i[json jsonb].include?(options[:format])
  model.instance_variable_set(:@llm_plugin_options, options.freeze)
end