pub struct GlobalInstructionPlugin { /* private fields */ }Expand description
Plugin that injects global instructions into every LLM request.
Useful for enforcing organization-wide policies, safety guidelines, or behavioral constraints across all agents.
Implementations§
Source§impl GlobalInstructionPlugin
impl GlobalInstructionPlugin
Sourcepub fn with_prepend(self, instruction: impl Into<String>) -> Self
pub fn with_prepend(self, instruction: impl Into<String>) -> Self
Set instructions to prepend to every system instruction.
Sourcepub fn with_append(self, instruction: impl Into<String>) -> Self
pub fn with_append(self, instruction: impl Into<String>) -> Self
Set instructions to append to every system instruction.
Trait Implementations§
Source§impl Default for GlobalInstructionPlugin
impl Default for GlobalInstructionPlugin
Source§impl Plugin for GlobalInstructionPlugin
impl Plugin for GlobalInstructionPlugin
Source§fn before_model<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_request: &'life1 LlmRequest,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn before_model<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_request: &'life1 LlmRequest,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Called before a model generation request.
Source§fn before_agent<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn before_agent<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Called before an agent starts execution.
Source§fn after_agent<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn after_agent<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Called after an agent completes execution.
Source§fn before_tool<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_call: &'life1 FunctionCall,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn before_tool<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_call: &'life1 FunctionCall,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Called before a tool is executed. Return
Deny to prevent execution.Source§fn after_tool<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
_call: &'life1 FunctionCall,
_result: &'life2 Value,
_ctx: &'life3 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
fn after_tool<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
_call: &'life1 FunctionCall,
_result: &'life2 Value,
_ctx: &'life3 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
Called after a tool completes. Can transform or deny the result.
Source§fn on_event<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_event: &'life1 Event,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn on_event<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_event: &'life1 Event,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Called when an event is emitted.
Source§fn on_user_message<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_message: &'life1 str,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn on_user_message<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_message: &'life1 str,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Called when a user message is received.
Source§fn before_run<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn before_run<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Called before a run starts (before the agent loop).
Source§fn after_run<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn after_run<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Called after a run completes (after the agent loop).
Source§fn after_model<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_response: &'life1 LlmResponse,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn after_model<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_response: &'life1 LlmResponse,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Called after a model generation response.
Source§fn on_model_error<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_error: &'life1 str,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn on_model_error<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_error: &'life1 str,
_ctx: &'life2 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Called when a model generation fails.
Source§fn on_tool_error<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
_call: &'life1 FunctionCall,
_error: &'life2 str,
_ctx: &'life3 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
fn on_tool_error<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
_call: &'life1 FunctionCall,
_error: &'life2 str,
_ctx: &'life3 InvocationContext,
) -> Pin<Box<dyn Future<Output = PluginResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
Called when a tool execution fails.
Auto Trait Implementations§
impl Freeze for GlobalInstructionPlugin
impl RefUnwindSafe for GlobalInstructionPlugin
impl Send for GlobalInstructionPlugin
impl Sync for GlobalInstructionPlugin
impl Unpin for GlobalInstructionPlugin
impl UnsafeUnpin for GlobalInstructionPlugin
impl UnwindSafe for GlobalInstructionPlugin
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more