Struct SemanticSimilarityMetric 

#[non_exhaustive]
pub struct SemanticSimilarityMetric<E> { /* private fields */ }

Available on crate feature experimental only.

A semantic similarity metric. Uses cosine similarity. In broad terms, cosine similarity can be used to measure how similar two documents are. This can be useful for things like quickly testing semantic similarity between two documents.

Implementations

impl<E> SemanticSimilarityMetric<E>

where E: EmbeddingModel,

pub fn builder(embedding_model: E) -> SemanticSimilarityMetricBuilder<E>

pub fn reference_answer(&self) -> &str

Trait Implementations

impl<E: Clone> Clone for SemanticSimilarityMetric<E>

fn clone(&self) -> SemanticSimilarityMetric<E>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug> Debug for SemanticSimilarityMetric<E>

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

Formats the value using the given formatter.

impl<E> Eval<SemanticSimilarityMetricScore> for SemanticSimilarityMetric<E>

where E: EmbeddingModel + 'static,

async fn eval( &self, input: String, ) -> EvalOutcome<SemanticSimilarityMetricScore>

fn eval_batch( &self, input: Vec<String>, concurrency_limit: usize, ) -> impl Future<Output = Vec<EvalOutcome<Output>>> + Send

Send a bunch of inputs to be evaluated all in one call. You can set the concurrency limit to help alleviate issues with model provider API limits, as sending requests too quickly may result in throttling or temporary request refusal.