Skip to main content

AnswerRelevancy

Struct AnswerRelevancy 

Source
pub struct AnswerRelevancy<M: BaseChatModel, E: Embeddings> { /* private fields */ }
Expand description

RAGAS answer relevancy: does the answer actually address the question?

The generator produces n questions that the answer could address (one LLM call); the score is the mean cosine similarity between the original question’s embedding and the generated questions’ embeddings. An answer full of on-topic-looking but non-answer text generates off-target questions and scores low, without needing a reference answer.

Uses one chat call (plain-text question list) plus one embedding batch per evaluation.

Implementations§

Source§

impl<M: BaseChatModel, E: Embeddings> AnswerRelevancy<M, E>

Source

pub fn new(generator: M, embeddings: E) -> Self

Creates an answer-relevancy evaluator.

Source

pub fn with_n_questions(self, n: usize) -> Self

Sets how many questions the generator should produce (clamped to at least 1).

Source

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

Score for an empty prediction (default 0.0: no answer is not relevant).

Trait Implementations§

Source§

impl<M: BaseChatModel, E: Embeddings> Evaluator for AnswerRelevancy<M, E>

Source§

fn eval<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, input: &'life1 str, prediction: &'life2 str, _reference: &'life3 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,

Scores a single prediction
Source§

fn name(&self) -> &str

Evaluator name (used in report summaries)
Source§

impl<M: BaseChatModel, E: Embeddings> RagEvaluator for AnswerRelevancy<M, E>

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, E> Freeze for AnswerRelevancy<M, E>
where M: Freeze, E: Freeze,

§

impl<M, E> RefUnwindSafe for AnswerRelevancy<M, E>

§

impl<M, E> Send for AnswerRelevancy<M, E>

§

impl<M, E> Sync for AnswerRelevancy<M, E>

§

impl<M, E> Unpin for AnswerRelevancy<M, E>
where M: Unpin, E: Unpin,

§

impl<M, E> UnsafeUnpin for AnswerRelevancy<M, E>
where M: UnsafeUnpin, E: UnsafeUnpin,

§

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