Skip to main content

Agent

Struct Agent 

Source
pub struct Agent<S>
where S: Clone + Send + Sync + 'static,
{ /* private fields */ }
Expand description

Production agent runtime.

Construct via Agent::builder; finalize with AgentBuilder::build. See module docs for the abstraction model and information-density discipline.

Implementations§

Source§

impl<S> Agent<S>
where S: Clone + Send + Sync + 'static,

Source

pub fn builder() -> AgentBuilder<S>

Start a fluent builder.

Source

pub fn name(&self) -> &str

Borrow the agent’s stable name. Always non-empty — AgentBuilder::build rejects empty / unset names so trace correlation never silently breaks.

Source

pub fn inner(&self) -> &Arc<dyn Runnable<S, S>>

Borrow the underlying runnable. Useful when an agent is embedded as a node in a larger graph and the parent needs direct access to the inner shape (e.g. for checkpointing).

Source

pub async fn execute( &self, input: S, ctx: &ExecutionContext, ) -> Result<AgentRunResult<S>>

Run to completion, returning the terminal state.

Emits a Started{run_id} opener, fires every registered observer at the appropriate lifecycle point, then emits either Complete{run_id, state} or Failed{run_id, error} on the sink — every run produces exactly one terminal event .

The run_id is inherited from ctx.run_id() when present, otherwise a fresh UUID v7 is generated and propagated to the inner runnable through a cloned context.

Source

pub async fn execute_with( &self, input: S, overrides: RunOverrides, ctx: &ExecutionContext, ) -> Result<AgentRunResult<S>>

Convenience entry that attaches a entelix_core::RunOverrides extension to the context for the duration of the call. Equivalent to agent.execute(input, &ctx.add_extension(overrides)) — shorter at the call site and signals the per-call shape at a glance.

Asymmetric by designRunOverrides is the agent-loop carrier (model / system prompt / max iterations owned by the loop the Agent itself drives) so a typed convenience belongs on Agent. RequestOverrides (temperature / top_p / top_k / max_tokens / stop_sequences / reasoning_effort / tool_choice / response_format / parallel_tool_calls) is ChatModel-shaped — the dispatch layer downstream picks it up via ExecutionContext::add_extension(RequestOverrides::new()…), no agent-side convenience is needed (and adding one would duplicate the orthogonality that the carrier split S99 established).

Operators threading multiple per-call extensions stay on Self::execute with their own add_extension chain.

Source

pub const fn execution_mode(&self) -> ExecutionMode

Borrow the configured execution mode.

Source

pub fn approver(&self) -> Option<&Arc<dyn Approver>>

Borrow the configured approver (None in Auto mode).

Source

pub fn observer_count(&self) -> usize

Number of registered lifecycle observers.

Source

pub fn execute_stream<'a>( &'a self, input: S, ctx: &'a ExecutionContext, ) -> BoxStream<'a, Result<AgentEvent<S>>>

Run with AgentEvent book-ends as a stream. Sinks attached at construction time receive the same events for fan-out telemetry.

The returned stream is the caller-facing view; the sink is the observability-facing view. Both observe the same StartedComplete(state) sequence that Self::execute produces — the only difference is the return shape (a stream of events vs the awaited terminal state).

Drives the inner runnable via Runnable::invoke rather than Runnable::stream so the lifecycle is identical to execute and the Complete event always fires on successful runs (a previous design routed through Runnable::stream’s Updates mode and could silently skip Complete for runnables that emit no per-node updates).

Construction is synchronous and infallible — every event (including the initial Started) yields lazily as the stream is polled. Callers consume with .next().await like any Stream; no extra .await on the constructor itself.

Trait Implementations§

Source§

impl<S> Debug for Agent<S>
where S: Clone + Send + Sync + 'static,

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<S> Runnable<S, S> for Agent<S>
where S: Clone + Send + Sync + 'static,

Agent<S> is itself a Runnable<S, S> so it composes inside larger graphs (recursive sub-agent dispatch).

The composition contract is S → S, so the AgentRunResult envelope is unwrapped here — composing graphs see only the terminal state. Callers that need the per-run UsageSnapshot or run_id go through Agent::execute directly.

Source§

fn invoke<'life0, 'life1, 'async_trait>( &'life0 self, input: S, ctx: &'life1 ExecutionContext, ) -> Pin<Box<dyn Future<Output = Result<S>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Single-shot invocation.
Source§

fn batch<'life0, 'life1, 'async_trait>( &'life0 self, inputs: Vec<I>, ctx: &'life1 ExecutionContext, ) -> Pin<Box<dyn Future<Output = Result<Vec<O>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Batch invocation. The default runs invoke sequentially over the input vector. Implementors that can parallelize (e.g. independent provider calls) override this.
Source§

fn stream<'life0, 'life1, 'async_trait>( &'life0 self, input: I, mode: StreamMode, ctx: &'life1 ExecutionContext, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<StreamChunk<O>, Error>> + Send + 'life0>>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Streaming invocation, shaped by mode (see StreamMode). Read more
Source§

fn name(&self) -> Cow<'_, str>

Human-readable identifier used by tracing and debug output. Default is the Rust type name — implementors may override with a domain label (e.g. "anthropic-messages", "json-parser").

Auto Trait Implementations§

§

impl<S> Freeze for Agent<S>

§

impl<S> !RefUnwindSafe for Agent<S>

§

impl<S> Send for Agent<S>

§

impl<S> Sync for Agent<S>

§

impl<S> Unpin for Agent<S>

§

impl<S> UnsafeUnpin for Agent<S>

§

impl<S> !UnwindSafe for Agent<S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, I, O> RunnableExt<I, O> for T
where T: Runnable<I, O> + 'static, I: Send + 'static, O: Send + 'static,

Source§

fn pipe<P, R>(self, next: R) -> RunnableSequence<I, O, P>
where P: Send + 'static, R: Runnable<O, P> + 'static,

Chain this runnable into next. The output O of self becomes the input of next, producing a Runnable<I, P>. Read more
Source§

fn with_retry(self, policy: RetryPolicy) -> Retrying<Self, I, O>
where I: Clone,

Wrap self with retry semantics. The returned runnable re-invokes the inner on transient errors per the policy. The input must be Clone because each retry receives a fresh copy. Read more
Source§

fn with_fallbacks<F>(self, fallbacks: Vec<F>) -> Fallback<Self, F, I, O>
where F: Runnable<I, O> + 'static, I: Clone,

Wrap self with an ordered fallback chain. On a transient error from the primary, the adapter tries each fallback in turn. Permanent errors surface immediately. The classifier is the same trait used by Self::with_retryentelix_core::transports::DefaultRetryClassifier by default. Read more
Source§

fn map<F, P>(self, f: F) -> Mapping<Self, F, I, O, P>
where F: Fn(O) -> P + Send + Sync + 'static, P: Send + 'static,

Map the inner’s output through a pure synchronous function. Equivalent to piping into a RunnableLambda but skipping the async wrapper. Read more
Source§

fn with_config<F>(self, configurer: F) -> Configured<Self, F, I, O>
where F: Fn(&mut ExecutionContext) + Send + Sync + 'static,

Run configurer on a cloned ExecutionContext before delegating to the inner. The caller’s ctx is not mutated. Read more
Source§

fn with_timeout(self, timeout: Duration) -> Timed<Self, I, O>

Race the inner against a wall-clock timeout. On expiry the adapter returns Error::DeadlineExceeded; caller cancellation still wins. Read more
Source§

fn stream_with<'life0, 'life1, 'async_trait>( &'life0 self, input: I, mode: StreamMode, ctx: &'life1 ExecutionContext, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<StreamChunk<O>, Error>> + Send + 'life0>>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: Sync + 'async_trait,

Convenience wrapper around Runnable::stream — same arguments, no trait import needed at the call site.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more