Skip to main content

AgentHandle

Struct AgentHandle 

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

Request extractor handing handlers a ready-to-run agent.

Autumn resolves it from app state before the handler runs:

ⓘ
use autumn_plugin_agent::plugin::AgentHandle;
use autumn_web::prelude::*;

#[get("/ask")]
async fn ask(agent: AgentHandle) -> String {
    agent
        .run("Summarize this quarter's plot trends.")
        .await
        .map(|outcome| format!("{outcome:?}"))
        .unwrap_or_else(|err| err.to_string())
}

Fails with 503 when the plugin was never installed.

Implementations§

Source§

impl AgentHandle

Source

pub fn agent(&self) -> Agent

Build an Agent with the plugin’s client, tools, and budgets.

Customize further with the builder methods before calling run.

Source

pub async fn run(&self, prompt: &str) -> Result<AgentOutcome, AgentError>

Run the agent loop with the plugin’s default settings.

§Errors

Returns AgentError when a provider call fails. Budget exhaustion is not an error: see Agent::run.

Source

pub async fn chat( &self, session: impl Into<SessionId>, input: &str, ) -> Result<AgentTurn, AgentError>

Run one turn in a persisted session with the plugin’s settings.

§Errors

See Agent::run_in_session.

Source

pub async fn chat_as( &self, scope: MemoryScope, session: impl Into<SessionId>, input: &str, ) -> Result<AgentTurn, AgentError>

Like AgentHandle::chat, with memory bound to scope (for example the signed-in user).

§Errors

See Agent::run_in_session.

Source

pub async fn resume( &self, state: RunState, decisions: Vec<ApprovalDecision>, ) -> Result<AgentTurn, AgentError>

Continue a paused run with a reviewer’s decisions, saving the transcript when the run belongs to a session.

§Errors

See Agent::resume.

Source

pub async fn resume_as( &self, scope: MemoryScope, state: RunState, decisions: Vec<ApprovalDecision>, ) -> Result<AgentTurn, AgentError>

Like AgentHandle::resume, with memory bound to scope. Use the scope the paused run started with (AgentHandle::chat_as).

§Errors

See Agent::resume.

Source

pub fn runtime(&self) -> &AgentRuntime

The shared runtime, for stores and settings.

Source

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

Names of the tools registered on the plugin.

Trait Implementations§

Source§

impl Clone for AgentHandle

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 Debug for AgentHandle

Source§

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

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

impl FromRequestParts<AppState> for AgentHandle

Source§

type Rejection = AutumnError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

fn from_request_parts( _parts: &mut Parts, state: &AppState, ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send

Perform the extraction.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<S, T> FromRequest<S, ViaParts> for T
where S: Send + Sync, T: FromRequestParts<S>,

Source§

type Rejection = <T as FromRequestParts<S>>::Rejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

fn from_request( req: Request<Body>, state: &S, ) -> impl Future<Output = Result<T, <T as FromRequest<S, ViaParts>>::Rejection>>

Perform the extraction.
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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scoped for T
where T: Send + Sync + 'static,

Source§

fn scope(ctx: &PolicyContext) -> ScopeQuery<'_, Self>

Open a deferred ScopeQuery for this type. Resolves the registered scope at .load() time, not here.
Source§

impl<T> TaskExtractor for T

Source§

fn from_task_parts<'a>( parts: &'a mut Parts, state: &'a AppState, ) -> Pin<Box<dyn Future<Output = Result<T, AutumnError>> + Send + 'a>>

Resolve an argument from task request parts and app state.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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