Enum RankBy 

pub enum RankBy {
    VectorSearch {
        field: String,
        method: VectorSearchMethod,
        query_vector: Vec<f32>,
    },
    FullTextSearch {
        field: String,
        method: String,
        query: String,
    },
    AttributeOrder {
        field: String,
        direction: SortDirection,
    },
    Sum(Vec<RankBy>),
    Max(Vec<RankBy>),
    Product {
        weight: f32,
        ranking: Box<RankBy>,
    },
}

Ranking function for unified query API Supports vector search (ANN/kNN), full-text BM25, and attribute ordering

Variants

VectorSearch

Vector search: uses field, method, and query_vector

Fields

field: String

method: VectorSearchMethod

query_vector: Vec<f32>

FullTextSearch

Full-text BM25 search

Fields

field: String

method: String

query: String

AttributeOrder

Attribute ordering

Fields

field: String

direction: SortDirection

Sum(Vec<RankBy>)

Sum of multiple ranking functions

Max(Vec<RankBy>)

Max of multiple ranking functions

Product

Product with weight

Fields

weight: f32

ranking: Box<RankBy>

Implementations

impl RankBy

pub fn vector_ann(field: impl Into<String>, query_vector: Vec<f32>) -> Self

Create a vector search ranking using ANN

pub fn ann(query_vector: Vec<f32>) -> Self

Create a vector search ranking using ANN on the default “vector” field

pub fn vector_knn(field: impl Into<String>, query_vector: Vec<f32>) -> Self

Create a vector search ranking using exact kNN

pub fn knn(query_vector: Vec<f32>) -> Self

Create a vector search ranking using kNN on the default “vector” field

pub fn bm25(field: impl Into<String>, query: impl Into<String>) -> Self

Create a BM25 full-text search ranking

pub fn asc(field: impl Into<String>) -> Self

Create an attribute ordering ranking (ascending)

pub fn desc(field: impl Into<String>) -> Self

Create an attribute ordering ranking (descending)

pub fn sum(rankings: Vec<RankBy>) -> Self

Sum multiple ranking functions together

pub fn max(rankings: Vec<RankBy>) -> Self

Take the max of multiple ranking functions

pub fn product(weight: f32, ranking: RankBy) -> Self

Apply a weight multiplier to a ranking function

Trait Implementations

impl Clone for RankBy

fn clone(&self) -> RankBy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RankBy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RankBy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RankBy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.