Struct CustomStrategy

pub struct CustomStrategy<Q> { /* private fields */ }

CustomStrategy provides a flexible way to generate retriever-specific search queries.

This struct implements a strategy pattern for vector similarity search, allowing different retrieval backends to provide their own query generation logic. Configuration is managed through the query generation closure, promoting a more flexible and composable design.

Type Parameters

• Q - The retriever-specific query type (e.g., sqlx::QueryBuilder for PostgreSQL)

Examples

// Define search configuration
const MAX_SEARCH_RESULTS: i64 = 5;

// Create a custom search strategy
let strategy = CustomStrategy::from_query(|query_node| {
    let mut builder = QueryBuilder::new();
     
    // Configure search parameters within the closure
    builder.push(" LIMIT ");
    builder.push_bind(MAX_SEARCH_RESULTS);
     
    Ok(builder)
});

Implementation Notes

• Search configuration (like result limits and vector fields) should be defined in the closure’s scope
• Implementers are responsible for validating configuration values
• The query generator has access to the full query state for maximum flexibility

Implementations

impl<Q: Send + Sync + 'static> CustomStrategy<Q>

pub fn from_query( query: impl Fn(&Query<Pending>) -> Result<Q> + Send + Sync + 'static, ) -> Self

Creates a new CustomStrategy with a query generation function.

The provided closure should contain all necessary configuration for query generation. This design allows for more flexible configuration management compared to struct-level fields.

Parameters

• query - A closure that generates retriever-specific queries

pub fn build_query(&self, query_node: &Query<Pending>) -> Result<Q>

Gets the query builder, which can then be used to build the actual query

Errors

This function will return an error if:

• No query function has been set (use from_query to set a query function).
• The query function fails while processing the provided query_node.

Trait Implementations

impl<Q> Clone for CustomStrategy<Q>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Q> Default for CustomStrategy<Q>

fn default() -> Self

Returns the “default value” for a type.

impl<Q: Send + Sync + 'static> SearchStrategy for CustomStrategy<Q>