Skip to main content

ContextRecall

Struct ContextRecall 

Source
pub struct ContextRecall<M: BaseChatModel> { /* private fields */ }
Expand description

RAGAS context recall: share of the reference answer’s claims that the retrieved contexts support.

The reference is split into atomic claims (same splitter faithfulness uses) and each claim is judged against the union of retrieved contexts; recall = attributable claims / total claims.

Implementations§

Source§

impl<M: BaseChatModel> ContextRecall<M>

Source

pub fn new(judge: M) -> Self

Creates a context-recall evaluator.

Source

pub fn with_max_context_chars(self, max: usize) -> Self

Character cap for the joined context block sent per claim.

Source

pub fn with_empty_score(self, score: f64) -> Self

Score when there is nothing to attribute (no claims / no contexts; default 0.0).

Trait Implementations§

Source§

impl<M: BaseChatModel> RagEvaluator for ContextRecall<M>

Source§

fn eval_rag<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, _input: &'life1 str, _prediction: &'life2 str, contexts: &'life3 [String], reference: &'life4 str, ) -> Pin<Box<dyn Future<Output = Result<Score, EvalError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Scores a single prediction given the question, retrieved contexts, and reference answer.
Source§

fn name(&self) -> &str

Evaluator name (used in report summaries)

Auto Trait Implementations§

§

impl<M> Freeze for ContextRecall<M>
where M: Freeze,

§

impl<M> RefUnwindSafe for ContextRecall<M>
where M: RefUnwindSafe,

§

impl<M> Send for ContextRecall<M>

§

impl<M> Sync for ContextRecall<M>

§

impl<M> Unpin for ContextRecall<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for ContextRecall<M>
where M: UnsafeUnpin,

§

impl<M> UnwindSafe for ContextRecall<M>
where M: 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> 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> 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, 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<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