LlmTextAgent

Struct LlmTextAgent 

Source
pub struct LlmTextAgent { /* private fields */ }
Expand description

Core text agent — calls BaseLlm::generate(), dispatches tools, loops until the model produces a final text response.

Middleware hooks fire at each lifecycle point:

  • before_model / after_model — wraps each BaseLlm::generate() call; before_model may return a cached response to skip the LLM entirely.
  • before_tool / after_tool / on_tool_error — wraps each tool dispatch.
  • on_error — called when run() is about to return an error.

Note: before_agent/after_agent are Live-session hooks that require an InvocationContext (a Live WebSocket concept) and are therefore not invoked by LlmTextAgent. Use before_model or wrap in a custom TextAgent if you need entry/exit hooks for the text path.

Implementations§

Source§

impl LlmTextAgent

Source

pub fn new(name: impl Into<String>, llm: impl BaseLlm + 'static) -> Self

Create a new LLM text agent.

llm is any BaseLlm: a GeminiLlm, a shared Arc<dyn BaseLlm>, or a MockLlm in tests.

Source

pub fn instruction(self, inst: impl Into<String>) -> Self

Set the system instruction.

Source

pub fn instruction_provider( self, provider: impl InstructionProvider + 'static, ) -> Self

Set a dynamic instruction source — an InstructionProvider (any Fn(&State) -> String closure, or a TemplateInstruction under the templates feature) resolved against session state at the start of every run. Wins over instruction.

Source

pub fn llm_provider<F>(self, provider: F) -> Self
where F: Fn(&State) -> Arc<dyn BaseLlm> + Send + Sync + 'static,

Set a dynamic model source, resolved against session state at the start of every run — risk-based escalation to a stronger model, cost routing to a cheaper one, per-tenant model selection — without rebuilding the agent. Wins over the constructor’s model when set.

Source

pub fn tools(self, dispatcher: Arc<ToolDispatcher>) -> Self

Set the tool dispatcher.

Source

pub fn model(self, model: impl Into<String>) -> Self

Call model instead of the provider’s default model, e.g. "gemini-2.5-pro".

Source

pub fn temperature(self, t: f32) -> Self

Set temperature.

Source

pub fn max_output_tokens(self, n: u32) -> Self

Set max output tokens.

Source

pub fn top_p(self, p: f32) -> Self

Set the nucleus sampling threshold.

Source

pub fn top_k(self, k: u32) -> Self

Sample from the k most likely tokens.

Source

pub fn stop_sequences( self, sequences: impl IntoIterator<Item = impl Into<String>>, ) -> Self

End generation when the model produces any of sequences.

Source

pub fn thinking_budget(self, tokens: u32) -> Self

Give the model a thinking budget, in tokens.

Source

pub fn built_in_tool(self, tool: Tool) -> Self

Add a built-in tool (Google Search, code execution, URL context), sent alongside the dispatcher’s function declarations.

Source

pub fn response_schema(self, schema: Value) -> Self

Constrain the reply to JSON matching schema.

Source

pub fn output_key(self, key: impl Into<String>) -> Self

Also write the final text to state under key (it is always written to "output").

Source

pub fn add_middleware(self, mw: Arc<dyn Middleware>) -> Self

Append a middleware layer to the chain.

Layers are run in insertion order for before_* / on_error hooks and in reverse insertion order for after_* hooks (outermost last).

Source

pub fn with_middleware_chain(self, chain: MiddlewareChain) -> Self

Replace the entire middleware chain (advanced — prefer add_middleware).

Trait Implementations§

Source§

impl TextAgent for LlmTextAgent

Source§

fn name(&self) -> &str

Human-readable name for logging and debugging.
Source§

fn run<'life0, 'life1, 'async_trait>( &'life0 self, state: &'life1 State, ) -> Pin<Box<dyn Future<Output = Result<String, AgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute this agent. Reads/writes state. Returns the final text output. Read more
Source§

fn run_with<'life0, 'life1, 'async_trait>( &'life0 self, request: RunRequest, state: &'life1 State, ) -> Pin<Box<dyn Future<Output = Result<RunResult, AgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run one request and report everything it produced: the reply, the turns to append to a conversation, token usage and tool calls. Read more
Source§

fn run_stream<'a>( &'a self, request: RunRequest, state: State, ) -> BoxStream<'a, Result<RunEvent, AgentError>>

Run one request as a stream of RunEvents: text as the model writes it, each tool call and result, then RunEvent::Finished. Read more
Source§

fn stream( &self, prompt: impl Into<String>, ) -> BoxStream<'_, Result<RunEvent, AgentError>>
where Self: Sized,

Stream the reply to one question, with no history and fresh state. Read more
Source§

fn ask<'life0, 'async_trait>( &'life0 self, prompt: impl 'async_trait + Into<String> + Send, ) -> Pin<Box<dyn Future<Output = Result<String, AgentError>> + Send + 'async_trait>>
where Self: Sized + 'async_trait, 'life0: 'async_trait,

Ask one question, with no history and fresh state, and get the reply.
Source§

fn ask_as<'life0, 'async_trait, T>( &'life0 self, prompt: impl 'async_trait + Into<String> + Send, ) -> Pin<Box<dyn Future<Output = Result<T, AgentError>> + Send + 'async_trait>>
where Self: Sized + 'async_trait, T: DeserializeOwned + JsonSchema + Send + 'async_trait, 'life0: 'async_trait,

Ask one question and get the reply as a T. Read more
Source§

fn chat(&self) -> Chat<&Self>
where Self: Sized,

Start a conversation that remembers its turns. See Chat.

Auto Trait Implementations§

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.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

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

§

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
§

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> 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,