Skip to main content

Agent

Struct Agent 

Source
pub struct Agent<M>
where M: ModelAdapter,
{ /* private fields */ }
Expand description

A configured agent ready to start a session.

Build one with Agent::builder, supplying at minimum a ModelAdapter. Optionally preload prior conversation state via AgentBuilder::transcript and the next user turn via AgentBuilder::input. Then call Agent::start with a SessionConfig to obtain a LoopDriver that drives the agentic loop.

If no input is preloaded, the first call to LoopDriver::next yields LoopInterrupt::AwaitingInput so the host can supply the first user message via InputRequest::submit. If input was preloaded, the first next() dispatches the model directly.

§Example

use agentkit_core::{Item, ItemKind};
use agentkit_loop::{
    Agent, PromptCacheRequest, PromptCacheRetention, SessionConfig,
};
use agentkit_tools_core::ToolRegistry;

let agent = Agent::builder()
    .model(adapter)
    .add_tool_source(ToolRegistry::new())
    .transcript(vec![Item::text(ItemKind::System, "You are a helpful assistant.")])
    .input(vec![Item::text(ItemKind::User, "Hello!")])
    .build()?;

let mut driver = agent
    .start(SessionConfig::new("s1").with_cache(
        PromptCacheRequest::automatic().with_retention(PromptCacheRetention::Short),
    ))
    .await?;

// First next() drives the model since input was preloaded.
let _ = driver.next().await?;

Implementations§

Source§

impl<M> Agent<M>
where M: ModelAdapter,

Source

pub fn builder() -> AgentBuilder<M>

Create a new AgentBuilder for configuring this agent.

Source

pub async fn start( &self, config: SessionConfig, ) -> Result<LoopDriver<M::Session>, LoopError>

Start a session, returning a LoopDriver preloaded with whatever transcript and input were configured on the builder. See AgentBuilder::transcript and AgentBuilder::input for what each one does and when to use them.

This calls ModelAdapter::start_session and emits an AgentEvent::RunStarted event to all registered observers.

&self so a single configured agent can mint multiple sessions over its lifetime — e.g. an outer agent that uses an inner sub-agent for transcript compaction.

§Errors

Returns LoopError if the model adapter fails to create a session.

Auto Trait Implementations§

§

impl<M> Freeze for Agent<M>
where M: Freeze,

§

impl<M> !RefUnwindSafe for Agent<M>

§

impl<M> Send for Agent<M>

§

impl<M> Sync for Agent<M>

§

impl<M> Unpin for Agent<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for Agent<M>
where M: UnsafeUnpin,

§

impl<M> !UnwindSafe for Agent<M>

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, 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