Skip to main content

GuardrailHook

Struct GuardrailHook 

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

An ObservabilityHook that runs guardrails on LLM input and output.

Built with a builder pattern. Input guardrails fire on HookEvent::PreLlmCall, output guardrails fire on HookEvent::PostLlmCall. All other events pass through with HookAction::Continue.

§Guardrail result mapping

§Example

use neuron_runtime::{GuardrailHook, InputGuardrail, OutputGuardrail, GuardrailResult};

struct NoSecrets;
impl InputGuardrail for NoSecrets {
    fn check(&self, input: &str) -> impl Future<Output = GuardrailResult> + Send {
        async move {
            if input.contains("sk-") {
                GuardrailResult::Tripwire("secret in input".to_string())
            } else {
                GuardrailResult::Pass
            }
        }
    }
}

let hook = GuardrailHook::new()
    .input_guardrail(NoSecrets);

Implementations§

Source§

impl GuardrailHook

Source

pub fn new() -> Self

Create an empty GuardrailHook with no guardrails.

Source

pub fn input_guardrail<G>(self, guardrail: G) -> Self
where G: ErasedInputGuardrail + 'static,

Add an input guardrail.

Input guardrails run on HookEvent::PreLlmCall, checking the last user message text in the request.

Source

pub fn output_guardrail<G>(self, guardrail: G) -> Self
where G: ErasedOutputGuardrail + 'static,

Add an output guardrail.

Output guardrails run on HookEvent::PostLlmCall, checking the assistant response text from the response message.

Trait Implementations§

Source§

impl Default for GuardrailHook

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl ObservabilityHook for GuardrailHook

Source§

fn on_event( &self, event: HookEvent<'_>, ) -> impl Future<Output = Result<HookAction, HookError>> + WasmCompatSend

Called for each event in the agentic loop.

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<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
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,