Skip to main content

Agent

Struct Agent 

Source
pub struct Agent { /* private fields */ }

Implementations§

Source§

impl Agent

Source

pub fn new( transport: Arc<dyn ProviderTransport>, tools: Arc<ToolRegistry>, memory: Arc<dyn MemoryStore>, config: Arc<AgentConfig>, ) -> Self

Source

pub fn with_session_db(self, db: Arc<SessionDb>) -> Self

Source

pub fn with_hooks(self, hooks: impl AgentHooks) -> Self

Source

pub fn tools(&self) -> &ToolRegistry

Source

pub fn has_tool(&self, name: &str) -> bool

Source

pub fn tool_count(&self) -> usize

Source

pub fn tool_names(&self) -> Vec<String>

Source

pub fn tool_names_by_toolset(&self) -> BTreeMap<String, Vec<String>>

Source

pub fn spawn_child(&self) -> Self

Source

pub fn clear_session(&self, session_key: &str)

Clear the stored conversation history for a platform session (e.g. on /new or /clear). Removes both the in-memory cache and the on-disk file, and clears any active goal.

Source

pub async fn set_goal(&self, session_key: &str, goal: &str) -> Result<()>

Source

pub async fn get_goal(&self, session_key: &str) -> Option<String>

Source

pub async fn clear_goal(&self, session_key: &str)

Source

pub fn history_pairs(&self, session_key: &str) -> Vec<(String, String)>

Prior (user, assistant) conversation pairs for a session — warm cache first, disk fallback on miss. Lets an embedding app (e.g. the desktop) repopulate the chat view on launch from the same store the agent uses.

Source

pub fn inject_history( &self, session_key: &str, user_msg: &str, assistant_msg: &str, )

Inject a (user, assistant) pair directly into conversation history without running the agent. Used by GatewayHandler to silently store image descriptions.

Source

pub fn update_last_history(&self, session_key: &str, new_assistant: &str)

Update the assistant content of the most recently injected history pair. Used to replace a placeholder description with the actual view_image result after the (potentially slow) tool call completes.

Source

pub async fn run_tool(&self, name: &str, args: Value) -> String

Call a single registered tool by name and return its output as a plain string. Intended for server-side preprocessing (e.g. gateway image pipeline) where the result must be available before the agent loop runs. Returns the tool’s content on success, or an error description on failure.

Source

pub async fn run_tool_scoped( &self, name: &str, args: Value, conv_key: &str, ) -> String

Like run_tool but sets conv_key so storage-scoped tools (e.g. doc_ingest, doc_search) operate on the correct conversation bucket.

Source

pub async fn run( &self, task: &str, approver: Arc<dyn CommandApprover>, platform: &str, hint: Option<&str>, session_key: Option<&str>, ) -> Result<AgentResult, AgentError>

Source

pub async fn run_for_user( &self, task: &str, approver: Arc<dyn CommandApprover>, platform: &str, hint: Option<&str>, session_key: Option<&str>, user_id: &str, ) -> Result<AgentResult, AgentError>

Source

pub async fn run_streaming( &self, task: &str, approver: Arc<dyn CommandApprover>, platform: &str, chunk_tx: UnboundedSender<String>, tool_tx: Option<UnboundedSender<String>>, hint: Option<&str>, session_key: Option<&str>, ) -> Result<AgentResult, AgentError>

Trait Implementations§

Source§

impl Clone for Agent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl SubAgentRunner for Agent

Source§

fn run_task<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, task: &'life1 str, session_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<String, AgentError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Auto Trait Implementations§

§

impl !RefUnwindSafe for Agent

§

impl !UnwindSafe for Agent

§

impl Freeze for Agent

§

impl Send for Agent

§

impl Sync for Agent

§

impl Unpin for Agent

§

impl UnsafeUnpin for Agent

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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: Sized + 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: Sized + 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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