Enum Hook

pub enum Hook {
    BeforeAll(Box<dyn BeforeAllFn>),
    BeforeCompletion(Box<dyn BeforeCompletionFn>),
    AfterCompletion(Box<dyn AfterCompletionFn>),
    BeforeTool(Box<dyn BeforeToolFn>),
    AfterTool(Box<dyn AfterToolFn>),
    AfterEach(Box<dyn AfterEachFn>),
    OnNewMessage(Box<dyn MessageHookFn>),
    OnStart(Box<dyn OnStartFn>),
    OnStop(Box<dyn OnStopFn>),
    OnStream(Box<dyn OnStreamFn>),
}

Wrapper around the different types of hooks

Variants

BeforeAll(Box<dyn BeforeAllFn>)

Runs only once for the agent when it starts

BeforeCompletion(Box<dyn BeforeCompletionFn>)

Runs before every completion, yielding a mutable reference to the completion request

AfterCompletion(Box<dyn AfterCompletionFn>)

Runs after every completion, yielding a mutable reference to the completion response

BeforeTool(Box<dyn BeforeToolFn>)

Runs before every tool call, yielding a reference to the tool call

AfterTool(Box<dyn AfterToolFn>)

Runs after every tool call, yielding a reference to the tool call and a mutable result

AfterEach(Box<dyn AfterEachFn>)

Runs after all tools have completed and a single completion has been made

OnNewMessage(Box<dyn MessageHookFn>)

Runs when a new message is added to the AgentContext, yielding a mutable reference to the message. This is only triggered when the message is added by the agent.

OnStart(Box<dyn OnStartFn>)

Runs when the agent starts, either from pending or stopped

OnStop(Box<dyn OnStopFn>)

Runs when the agent stops

OnStream(Box<dyn OnStreamFn>)

Runs when the agent streams a response

Trait Implementations

impl Clone for Hook

fn clone(&self) -> Hook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for Hook

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

Formats the value using the given formatter.

impl<'_enum> From<&'_enum Hook> for HookTypes

fn from(val: &'_enum Hook) -> HookTypes

Converts to this type from the input type.

impl From<Hook> for HookTypes

fn from(val: Hook) -> HookTypes

Converts to this type from the input type.

impl IntoDiscriminant for Hook

type Discriminant = HookTypes

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant