Skip to main content

ChainedHook

Struct ChainedHook 

Source
pub struct ChainedHook<A, B> { /* private fields */ }
Expand description

Combine two PromptHooks into one. See module docs for combination semantics.

When ChainedHook::observe_with sets a conversation ID, the chain also emits synthetic tool.skipped / tool.terminated events for tool calls whose combined action is Skip / Terminate. This closes the tool.invoked / tool.completed correlation gap when chaining a telemetry hook with a gating hook.

Implementations§

Source§

impl<A, B> ChainedHook<A, B>

Source

pub fn new(a: A, b: B) -> Self

Build a chained hook running a before b for every lifecycle event. By default the chain emits no synthetic terminal events; use ChainedHook::observe_with to opt in.

Source

pub fn observe_with(self, conversation_id: impl Into<String>) -> Self

Opt in to synthetic tool.skipped / tool.terminated event emission stamped with conversation_id. Use the same conversation ID configured on the chain’s telemetry hook so pair-correlation by call_id works end-to-end.

Trait Implementations§

Source§

impl<A: Clone, B: Clone> Clone for ChainedHook<A, B>

Source§

fn clone(&self) -> ChainedHook<A, B>

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<A: Debug, B: Debug> Debug for ChainedHook<A, B>

Source§

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

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

impl<A, B, M> PromptHook<M> for ChainedHook<A, B>
where A: PromptHook<M>, B: PromptHook<M>, M: CompletionModel,

Source§

async fn on_completion_call( &self, prompt: &Message, history: &[Message], ) -> HookAction

Called before the prompt is sent to the model
Source§

async fn on_completion_response( &self, prompt: &Message, response: &CompletionResponse<M::Response>, ) -> HookAction

Called after the prompt is sent to the model and a response is received.
Source§

async fn on_tool_call( &self, tool_name: &str, tool_call_id: Option<String>, internal_call_id: &str, args: &str, ) -> ToolCallHookAction

Called before a tool is invoked. Read more
Source§

async fn on_tool_result( &self, tool_name: &str, tool_call_id: Option<String>, internal_call_id: &str, args: &str, result: &str, ) -> HookAction

Called after a tool is invoked (and a result has been returned).
Source§

fn on_text_delta( &self, _text_delta: &str, _aggregated_text: &str, ) -> impl Future<Output = HookAction> + Send

Called when receiving a text delta (streaming responses only)
Source§

fn on_tool_call_delta( &self, _tool_call_id: &str, _internal_call_id: &str, _tool_name: Option<&str>, _tool_call_delta: &str, ) -> impl Future<Output = HookAction> + Send

Called when receiving a tool call delta (streaming_responses_only). tool_name is Some on the first delta for a tool call, None on subsequent deltas.
Source§

fn on_stream_completion_response_finish( &self, _prompt: &Message, _response: &<M as CompletionModel>::StreamingResponse, ) -> impl Future<Output = HookAction> + Send

Called after the model provider has finished streaming a text response from their completion API to the client.

Auto Trait Implementations§

§

impl<A, B> Freeze for ChainedHook<A, B>
where A: Freeze, B: Freeze,

§

impl<A, B> RefUnwindSafe for ChainedHook<A, B>

§

impl<A, B> Send for ChainedHook<A, B>
where A: Send, B: Send,

§

impl<A, B> Sync for ChainedHook<A, B>
where A: Sync, B: Sync,

§

impl<A, B> Unpin for ChainedHook<A, B>
where A: Unpin, B: Unpin,

§

impl<A, B> UnsafeUnpin for ChainedHook<A, B>
where A: UnsafeUnpin, B: UnsafeUnpin,

§

impl<A, B> UnwindSafe for ChainedHook<A, B>
where A: UnwindSafe, B: UnwindSafe,

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> 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: 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: 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> 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
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,