Module: LLM::ActiveRecord::ActsAsLLM::InstanceMethods

Defined in:
lib/llm/active_record/acts_as_llm.rb

Instance Method Summary collapse

Instance Method Details

#ask ⇒ LLM::Response

Continues the stored context with new input and flushes it.

Returns:

See Also:



71
72
73
74
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 71

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

#context_usage ⇒ Rational?

Returns context window usage as a Rational

Returns:

  • (Rational, nil) 


152
153
154
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 152

def context_usage
  ctx.context_usage
end

#context_used ⇒ Integer

Returns how many tokens have been used within the context window

Returns:

  • (Integer) 


145
146
147
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 145

def context_used
  ctx.context_used
end

#context_window ⇒ Integer

Returns:

  • (Integer)

See Also:



137
138
139
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 137

def context_window
  ctx.context_window
end

#cost ⇒ LLM::Cost

Returns:

See Also:



130
131
132
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 130

def cost
  ctx.cost
end

#image_url ⇒ LLM::Object

Returns:

See Also:



183
184
185
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 183

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

#interrupt! ⇒ nil Also known as: cancel!

Returns:

  • (nil)

See Also:



167
168
169
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 167

def interrupt!
  ctx.interrupt!
end

#llm ⇒ LLM::Provider

Returns the resolved provider instance for this record.

Returns:



211
212
213
214
215
216
217
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 211

def llm
  options = self.class.llm_plugin_options
  return @llm if @llm
  @llm = Utils.resolve_provider(self, options, EMPTY_HASH)
  @llm.tracer = Utils.resolve_option(self, options[:tracer]) if options[:tracer]
  @llm
end

#local_file ⇒ LLM::Object

Returns:

See Also:



190
191
192
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 190

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

#messages ⇒ Array<LLM::Message>

Returns:

See Also:



94
95
96
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 94

def messages
  ctx.messages
end

#mode ⇒ Symbol

Returns:

  • (Symbol)

See Also:



87
88
89
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 87

def mode
  ctx.mode
end

#model! ⇒ String

Note:

The bang keeps the ActiveRecord and Sequel wrappers aligned.

Returns:

  • (String)

See Also:



102
103
104
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 102

def model!
  ctx.model
end

#pending_functions ⇒ Array<LLM::Function>

Returns:

See Also:



109
110
111
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 109

def pending_functions
  ctx.pending_functions
end

#pending_functions? ⇒ Boolean

Returns:

  • (Boolean)

See Also:



116
117
118
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 116

def pending_functions?
  ctx.pending_functions?
end

#prompt ⇒ LLM::Prompt Also known as: build_prompt

Returns:

See Also:



175
176
177
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 175

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

#remote_file ⇒ LLM::Object

Returns:

See Also:



197
198
199
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 197

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

#returns ⇒ Array<LLM::Function::Return>

Returns:

See Also:



123
124
125
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 123

def returns
  ctx.returns
end

#talk ⇒ LLM::Response

Continues the stored context with new input and flushes it.

Returns:

See Also:



62
63
64
65
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 62

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

#token_usage ⇒ LLM::Usage Also known as: usage

Returns usage from the mapped usage columns.

Returns:



159
160
161
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 159

def token_usage
  ctx.token_usage
end

#tracer ⇒ LLM::Tracer

Returns:

See Also:



204
205
206
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 204

def tracer
  ctx.tracer
end

#wait ⇒ Array<LLM::Function::Return>

Waits for queued tool work to finish.

Returns:

See Also:



80
81
82
 
# File 'lib/llm/active_record/acts_as_llm.rb', line 80

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