Class: Phronomy::Agent::Base
- Inherits:
-
Object
- Object
- Phronomy::Agent::Base
- Includes:
- Concerns::BeforeCompletion, Concerns::ErrorTranslation, Concerns::Guardrailable, Concerns::Retryable, Concerns::Suspendable, Runnable
- Defined in:
- lib/phronomy/agent/base.rb
Overview
Base class for all Phronomy agents.
Subclass this to create a conversational agent powered by an LLM. DSL class methods configure the model, instructions, tools, memory, and retry behaviour. Instance methods handle invocation.
Direct Known Subclasses
Instance Attribute Summary
Attributes included from Concerns::BeforeCompletion
Class Method Summary collapse
-
.cache_instructions(enabled = nil) ⇒ Object
When enabled, attaches Anthropic prompt-cache markers to the system message so that the fixed instructions are served from cache on subsequent turns, reducing input-token costs.
-
.context_overhead(val = nil) ⇒ Object
Tokens reserved for the system prompt + tool definitions overhead.
-
.context_window(val = nil) ⇒ Object
Overrides the context window size used for token budget calculations.
-
.instructions(text = nil) { ... } ⇒ String, ...
Sets or reads the system instructions for this agent.
-
.invoke_timeout(val = nil) ⇒ Numeric?
Sets or reads the per-invocation timeout (in seconds) for EventLoop-mode agent calls.
-
.max_iterations(val = nil) ⇒ Integer
Sets or reads the maximum number of LLM call cycles for ReAct agents.
-
.max_output_tokens(val = nil) ⇒ Object
Tokens to reserve for the model's output.
-
.max_parallel_tools(val = nil) ⇒ Integer
Sets or reads the maximum number of tool calls executed concurrently when the LLM returns multiple tool calls in a single response (ParallelToolChat mode, active inside an AgentFSM IO thread).
-
.model(name = nil) ⇒ String?
Sets or reads the LLM model identifier for this agent.
-
.provider(name = nil) ⇒ Symbol?
Sets or reads the LLM provider for this agent.
-
.resume(checkpoint, approved:, config: {}) ⇒ Hash
Resumes a suspended invocation identified by +checkpoint+ without requiring the original agent instance to be kept in memory.
-
.static_knowledge(*sources) ⇒ Object
Registers one or more static knowledge sources on the agent class.
-
.static_knowledge_chunks ⇒ Array<Hash>
Returns the fetched content from all static knowledge sources.
-
.static_knowledge_refresh! ⇒ nil
Clears the class-level knowledge cache so that the next +invoke+ call re-fetches content from all registered static knowledge sources.
-
.static_knowledge_sources ⇒ Array<Phronomy::Agent::Context::Knowledge::Base>
Returns the registered static knowledge sources.
-
.temperature(val = nil) ⇒ Float?
Sets or reads the sampling temperature sent to the LLM.
-
.tool_aliases ⇒ Hash{Class => String}
Returns the alias map registered via the hash form of .tools.
-
.tools(*args) ⇒ Object
Registers tool classes for this agent.
Instance Method Summary collapse
-
#_add_handoff_tool(tool_class) ⇒ self
private
Registers an anonymous handoff tool class on this agent instance.
-
#_handoff_tools ⇒ Array<Class>
private
Returns handoff tool classes registered on this instance by Runner.
-
#context_version_cache ⇒ Object
deprecated
private
Deprecated.
The context version cache has been removed. Returns nil. Retained for backward compatibility with callers using safe navigation (+&.reset+).
-
#invoke(input, messages: [], thread_id: nil, config: {}, invocation_context: nil) ⇒ Hash
Invokes the agent with the given input and returns a result Hash.
-
#invoke_async(input, messages: [], thread_id: nil, config: {}, invocation_context: nil) ⇒ Phronomy::Task
Invokes this agent asynchronously and returns a Task.
-
#run_as_child(input, ctx:, messages: [], config: {}) ⇒ nil
Registers this agent as a child AgentFSM inside the given Workflow context.
-
#stream(input, messages: [], thread_id: nil, config: {}) {|Phronomy::Agent::StreamEvent| ... } ⇒ Hash
Streaming version of #invoke.
Methods included from Concerns::Suspendable
#checkpoint_store=, #on_approval_required, #resume, #scope_policy=
Methods included from Concerns::BeforeCompletion
Methods included from Concerns::Guardrailable
#add_input_guardrail, #add_output_guardrail
Methods included from Concerns::Retryable
Methods included from Runnable
Class Method Details
.cache_instructions(enabled = nil) ⇒ Object
When enabled, attaches Anthropic prompt-cache markers to the system message so that the fixed instructions are served from cache on subsequent turns, reducing input-token costs.
Only has an effect when the agent also declares provider :anthropic.
The cache_control field is provider-specific (the format differs
between Anthropic direct, Bedrock, etc.), so the agent must explicitly
declare its provider via the DSL rather than having it inferred from
the model name.
321 322 323 324 325 326 327 |
# File 'lib/phronomy/agent/base.rb', line 321 def cache_instructions(enabled = nil) if enabled.nil? @cache_instructions else @cache_instructions = enabled end end |
.context_overhead(val = nil) ⇒ Object
Tokens reserved for the system prompt + tool definitions overhead. Subtract this from the context window before computing the memory budget.
371 372 373 374 375 376 377 |
# File 'lib/phronomy/agent/base.rb', line 371 def context_overhead(val = nil) if val.nil? @context_overhead || 0 else @context_overhead = val.to_i end end |
.context_window(val = nil) ⇒ Object
Overrides the context window size used for token budget calculations. When set, this value takes precedence over the RubyLLM model registry, which is useful for locally-hosted models (e.g. LM Studio) where the actually-loaded context length may differ from the catalogue value.
355 356 357 358 359 360 361 |
# File 'lib/phronomy/agent/base.rb', line 355 def context_window(val = nil) if val.nil? @context_window else @context_window = val.to_i end end |
.instructions(text = nil) { ... } ⇒ String, ...
Sets or reads the system instructions for this agent. Accepts a String, a Context::Instruction::PromptTemplate, or a block (Proc). When used as a reader (no argument, no block), returns the stored value.
78 79 80 81 82 83 84 85 |
# File 'lib/phronomy/agent/base.rb', line 78 def instructions(text = nil, &block) if text || block_given? @instructions = text || block else return @instructions if instance_variable_defined?(:@instructions) superclass.respond_to?(:instructions) ? superclass.instructions : nil end end |
.invoke_timeout(val = nil) ⇒ Numeric?
Sets or reads the per-invocation timeout (in seconds) for EventLoop-mode agent calls. When set, +invoke+ raises TimeoutError if the agent does not finish within the given number of seconds.
Has no effect when EventLoop mode is disabled (direct invoke path). Defaults to +nil+ (no timeout). Inherited by subclasses; the most-specific definition wins.
When the timeout fires, a Concurrency::CancellationScope is cancelled and its token is propagated to the FSM config so that in-flight LLM, tool, and RAG calls observe cancellation via their +cancellation_token:+ keyword argument. +Phronomy::TimeoutError+ is raised to the caller.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/phronomy/agent/base.rb', line 240 def invoke_timeout(val = nil) if val.nil? return @invoke_timeout if defined?(@invoke_timeout) superclass.respond_to?(:invoke_timeout) ? superclass.invoke_timeout : nil else unless val.is_a?(Numeric) && val > 0 raise ArgumentError, "invoke_timeout must be a positive number, got #{val.inspect}" end @invoke_timeout = val end end |
.max_iterations(val = nil) ⇒ Integer
Sets or reads the maximum number of LLM call cycles for ReAct agents. Each tool call and follow-up counts as one iteration. Defaults to 10.
185 186 187 188 189 190 191 |
# File 'lib/phronomy/agent/base.rb', line 185 def max_iterations(val = nil) if val @max_iterations = val else @max_iterations || 10 end end |
.max_output_tokens(val = nil) ⇒ Object
Tokens to reserve for the model's output. When nil, the model's max_output_tokens from the registry is used.
337 338 339 340 341 342 343 |
# File 'lib/phronomy/agent/base.rb', line 337 def max_output_tokens(val = nil) if val.nil? @max_output_tokens else @max_output_tokens = val.to_i end end |
.max_parallel_tools(val = nil) ⇒ Integer
Sets or reads the maximum number of tool calls executed concurrently when the LLM returns multiple tool calls in a single response (ParallelToolChat mode, active inside an AgentFSM IO thread).
Defaults to 10. Set to 1 to force sequential execution. Inherited by subclasses; the most-specific definition wins.
207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/phronomy/agent/base.rb', line 207 def max_parallel_tools(val = nil) if val.nil? @max_parallel_tools || (superclass.respond_to?(:max_parallel_tools) ? superclass.max_parallel_tools : 10) else unless val.is_a?(Integer) && val >= 1 raise ArgumentError, "max_parallel_tools must be a positive Integer (>= 1), got #{val.inspect}" end @max_parallel_tools = val end end |
.model(name = nil) ⇒ String?
Sets or reads the LLM model identifier for this agent. When called without an argument, returns the stored model or the global default from Phronomy.configuration.
54 55 56 57 58 59 60 |
# File 'lib/phronomy/agent/base.rb', line 54 def model(name = nil) if name @model = name else @model || Phronomy.configuration.default_model end end |
.provider(name = nil) ⇒ Symbol?
Sets or reads the LLM provider for this agent. Required when using a model not registered in RubyLLM's model registry (e.g. locally-hosted models via LM Studio or Ollama).
148 149 150 151 152 153 154 155 |
# File 'lib/phronomy/agent/base.rb', line 148 def provider(name = nil) if name @provider = name else return @provider if instance_variable_defined?(:@provider) superclass.respond_to?(:provider) ? superclass.provider : nil end end |
.resume(checkpoint, approved:, config: {}) ⇒ Hash
Resumes a suspended invocation identified by +checkpoint+ without requiring the original agent instance to be kept in memory.
Validates that the checkpoint was created by this agent class, then instantiates a fresh agent and delegates to Suspendable#resume.
392 393 394 395 396 397 398 |
# File 'lib/phronomy/agent/base.rb', line 392 def resume(checkpoint, approved:, config: {}) if checkpoint.agent_class && checkpoint.agent_class != name raise ArgumentError, "checkpoint belongs to #{checkpoint.agent_class}, cannot resume with #{name}" end new.resume(checkpoint, approved: approved, config: config) end |
.static_knowledge(*sources) ⇒ Object
Registers one or more static knowledge sources on the agent class. Static source content is fetched and memoized at the class level the first time +invoke+ is called. The cache persists for the lifetime of the process; call static_knowledge_refresh! to force a reload.
264 265 266 267 268 269 |
# File 'lib/phronomy/agent/base.rb', line 264 def static_knowledge(*sources) @static_knowledge_sources = sources.flatten # Invalidate the cached chunks so the new sources are fetched on # the next call to static_knowledge_chunks. @static_knowledge_chunks = nil end |
.static_knowledge_chunks ⇒ Array<Hash>
Returns the fetched content from all static knowledge sources. Results are cached at the class level so that each source is fetched only once regardless of how many times the agent is invoked.
283 284 285 286 287 |
# File 'lib/phronomy/agent/base.rb', line 283 def static_knowledge_chunks @static_knowledge_chunks ||= static_knowledge_sources.flat_map { |ks| ks.fetch(query: nil) } end |
.static_knowledge_refresh! ⇒ nil
Clears the class-level knowledge cache so that the next +invoke+ call re-fetches content from all registered static knowledge sources.
Call this method when the underlying knowledge source has been updated at runtime (e.g. a file was rewritten, a DB record changed) and you want the agent to pick up the new content without restarting the process.
301 302 303 |
# File 'lib/phronomy/agent/base.rb', line 301 def static_knowledge_refresh! @static_knowledge_chunks = nil end |
.static_knowledge_sources ⇒ Array<Phronomy::Agent::Context::Knowledge::Base>
Returns the registered static knowledge sources.
274 275 276 |
# File 'lib/phronomy/agent/base.rb', line 274 def static_knowledge_sources @static_knowledge_sources || [] end |
.temperature(val = nil) ⇒ Float?
Sets or reads the sampling temperature sent to the LLM. When nil, the provider's default is used.
167 168 169 170 171 172 173 |
# File 'lib/phronomy/agent/base.rb', line 167 def temperature(val = nil) if val @temperature = val else @temperature end end |
.tool_aliases ⇒ Hash{Class => String}
Returns the alias map registered via the hash form of .tools. Merges parent class aliases so subclasses inherit their parent's mappings. Subclass-specific aliases take precedence over parent aliases.
127 128 129 130 131 132 133 134 |
# File 'lib/phronomy/agent/base.rb', line 127 def tool_aliases own = @tool_aliases || {} if superclass.respond_to?(:tool_aliases) superclass.tool_aliases.merge(own) else own end end |
.tools(*args) ⇒ Object
Registers tool classes for this agent.
Accepts either a splat of classes (backward-compatible) or a Hash mapping each class to an explicit alias name (String) or nil (use tool's own name). The alias form is useful when two tools share the same auto-generated name (e.g. two SearchTool classes from different modules).
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/phronomy/agent/base.rb', line 104 def tools(*args) if args.empty? if instance_variable_defined?(:@tools) return @tools end return superclass.respond_to?(:tools) ? superclass.tools : [] end if args.length == 1 && args.first.is_a?(Hash) hash = args.first @tools = hash.keys @tool_aliases = hash.transform_values { |v| v&.to_s }.reject { |_, v| v.nil? } else @tools = args @tool_aliases = {} end end |
Instance Method Details
#_add_handoff_tool(tool_class) ⇒ self
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Registers an anonymous handoff tool class on this agent instance. Called by Runner during construction when routes are configured.
406 407 408 409 410 |
# File 'lib/phronomy/agent/base.rb', line 406 def _add_handoff_tool(tool_class) @_handoff_tools ||= [] @_handoff_tools << tool_class self end |
#_handoff_tools ⇒ Array<Class>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns handoff tool classes registered on this instance by Runner.
415 416 417 |
# File 'lib/phronomy/agent/base.rb', line 415 def _handoff_tools @_handoff_tools || [] end |
#context_version_cache ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The context version cache has been removed. Returns nil. Retained for backward compatibility with callers using safe navigation (+&.reset+).
614 615 616 |
# File 'lib/phronomy/agent/base.rb', line 614 def context_version_cache nil end |
#invoke(input, messages: [], thread_id: nil, config: {}, invocation_context: nil) ⇒ Hash
Invokes the agent with the given input and returns a result Hash. Applies the retry policy configured via retry_policy when transient errors occur. GuardrailError is never retried.
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 |
# File 'lib/phronomy/agent/base.rb', line 463 def invoke(input, messages: [], thread_id: nil, config: {}, invocation_context: nil) if invocation_context thread_id, config = _apply_invocation_context(thread_id, config, invocation_context) end _check_scheduler_reentrancy timeout_sec = self.class.invoke_timeout unless timeout_sec return invoke_async(input, messages: , thread_id: thread_id, config: config).await end # invoke_timeout: create a CancellationScope with deadline, pass its token # to the async invocation, and use scope.pop_queue so the calling thread # unblocks as soon as either the result arrives or the deadline fires. scope = Phronomy::Concurrency::CancellationScope.new(parent_token: config[:cancellation_token]) scope.deadline_in(timeout_sec) effective_config = config.merge(cancellation_token: scope.token) task = invoke_async(input, messages: , thread_id: thread_id, config: effective_config) # Bridge the task result to an AsyncQueue so scope.pop_queue can observe the deadline. completion_queue = Phronomy::Concurrency::AsyncQueue.new Phronomy::Runtime.instance.spawn(name: "invoke-timeout-bridge:#{(self.class.name || "agent").downcase}") do completion_queue.push(task.await) rescue => e completion_queue.push(e) end result = scope.pop_queue(completion_queue) do raise Phronomy::TimeoutError, "Agent #{self.class.name} invoke timed out after #{timeout_sec}s" end raise result if result.is_a?(Exception) result end |
#invoke_async(input, messages: [], thread_id: nil, config: {}, invocation_context: nil) ⇒ Phronomy::Task
Invokes this agent asynchronously and returns a Task.
This is the primary async entry point. #invoke is a synchronous wrapper that calls this method and blocks the caller until the task completes. Calling #invoke from inside an active scheduler task raises SchedulerReentrancyError; use +invoke_async+ directly in that context.
The task is registered with the Runtime task registry so Runtime#shutdown drains in-flight invocations before process exit.
520 521 522 523 524 525 526 527 528 529 530 531 532 533 |
# File 'lib/phronomy/agent/base.rb', line 520 def invoke_async(input, messages: [], thread_id: nil, config: {}, invocation_context: nil) if invocation_context thread_id, config = _apply_invocation_context(thread_id, config, invocation_context) end bp = Phronomy.configuration.backpressure on_full = (bp == :raise) ? :reject : (bp || :wait) bp_timeout = Phronomy.configuration.backpressure_timeout gate = Phronomy::Runtime.instance.gate(:agent) Phronomy::Runtime.instance.spawn(name: "agent-#{(self.class.name || "anonymous").downcase}-async") do gate.acquire(on_full: on_full, timeout: bp_timeout) do _invoke_impl(input, messages: , thread_id: thread_id, config: config) end end end |
#run_as_child(input, ctx:, messages: [], config: {}) ⇒ nil
Registers this agent as a child AgentFSM inside the given Workflow context.
Use this method from a Workflow entry action (running on the EventLoop thread) instead of #invoke, which would raise a deadlock error because +invoke+ blocks on a +Thread::Queue+ when EventLoop mode is active.
The agent runs asynchronously in a background IO thread. When it finishes, the parent FSMSession receives a +:child_completed+ event whose payload is the result hash +{ output:, messages:, usage: }+. Declare an +on: :child_completed+ transition in your Workflow to advance to the next state.
The result is delivered exclusively as the +:child_completed+ event payload. The parent Workflow task is the sole owner of the parent +WorkflowContext+ and applies the result after receiving the event — no background thread writes to the parent context directly.
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 |
# File 'lib/phronomy/agent/base.rb', line 563 def run_as_child(input, ctx:, messages: [], config: {}) unless Phronomy.configuration.event_loop raise Phronomy::Error, "run_as_child requires EventLoop mode. " \ "Enable with: Phronomy.configure { |c| c.event_loop = true }" end parent_id = ctx.thread_id thread_id = "#{parent_id}_agent_#{SecureRandom.uuid}" Phronomy::Runtime.instance.spawn(name: "agent-child:#{thread_id}") do result = _invoke_impl(input, messages: , thread_id: thread_id, config: config) Phronomy::EventLoop.instance.post( Phronomy::Event.new(type: :child_completed, target_id: parent_id, payload: result) ) rescue => e Phronomy::EventLoop.instance.post( Phronomy::Event.new(type: :child_failed, target_id: parent_id, payload: e) ) end nil end |
#stream(input, messages: [], thread_id: nil, config: {}) {|Phronomy::Agent::StreamEvent| ... } ⇒ Hash
Streaming version of #invoke. Yields StreamEvent objects as they are produced by the underlying LLM.
Events emitted (in order): :token — each content delta from the LLM :tool_call — when the LLM requests a tool :tool_result — after a tool completes :done — final event carrying output, messages, and usage :error — if an unrecoverable error occurs
602 603 604 605 606 607 608 609 |
# File 'lib/phronomy/agent/base.rb', line 602 def stream(input, messages: [], thread_id: nil, config: {}, &block) return invoke(input, messages: , thread_id: thread_id, config: config) unless block _stream_impl(input, messages: , thread_id: thread_id, config: config, &block) rescue => e block&.call(StreamEvent.new(type: :error, payload: {error: e})) raise end |