Struct SemanticSimilarityExampleSelector 

pub struct SemanticSimilarityExampleSelector { /* private fields */ }

Selects the k examples most similar to the input, by embedding cosine similarity, most similar first.

An example’s text is its values joined by spaces in key order. With with_input_keys only those keys are used, both for the examples and for the input (so the expected output doesn’t count).

let selector = SemanticSimilarityExampleSelector::from_examples(
    examples,
    OllamaEmbedder::default(),
    2,
)
.await?
.with_input_keys(["input"]);

Implementations

impl SemanticSimilarityExampleSelector

pub const DEFAULT_K: usize = 4

Default number of examples to select.

pub fn new<E: Embedder + 'static>(embedder: E) -> Self

An empty selector; add examples with ExampleSelector::add_example.

pub fn with_embedder(embedder: Arc<dyn Embedder>) -> Self

Like new, with an embedder shared with other components.

pub async fn from_examples<E: Embedder + 'static>( examples: Vec<PromptArgs>, embedder: E, k: usize, ) -> Result<Self, PromptError>

A selector over examples (embedded in one batch) that picks k of them.

pub fn with_k(self, k: usize) -> Self

How many examples to select.

pub fn with_input_keys<I, S>(self, keys: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Only these keys are embedded, for examples and input alike. Examples are re-embedded when added, so set this before adding them.

pub async fn add_examples( &self, examples: Vec<PromptArgs>, ) -> Result<(), PromptError>

Adds several examples, embedded in one batch.

Trait Implementations

impl Debug for SemanticSimilarityExampleSelector

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

Formats the value using the given formatter.

impl ExampleSelector for SemanticSimilarityExampleSelector

fn add_example<'life0, 'async_trait>( &'life0 self, example: PromptArgs, ) -> Pin<Box<dyn Future<Output = Result<(), PromptError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds an example to the pool the selector chooses from.

fn select_examples<'life0, 'life1, 'async_trait>( &'life0 self, input_variables: &'life1 PromptArgs, ) -> Pin<Box<dyn Future<Output = Result<Vec<PromptArgs>, PromptError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The examples to use for input_variables (the prompt’s inputs), in the order they should appear.