Struct TrieveKnowledgeBaseSearchPlan

pub struct TrieveKnowledgeBaseSearchPlan {
    pub top_k: Option<f64>,
    pub remove_stop_words: Option<bool>,
    pub score_threshold: Option<f64>,
    pub search_type: SearchTypeTrue,
}

Fields

top_k: Option<f64>

Specifies the number of top chunks to return. This corresponds to the page_size parameter in Trieve.

remove_stop_words: Option<bool>

If true, stop words (specified in server/src/stop-words.txt in the git repo) will be removed. This will preserve queries that are entirely stop words.

score_threshold: Option<f64>

This is the score threshold to filter out chunks with a score below the threshold for cosine distance metric. For Manhattan Distance, Euclidean Distance, and Dot Product, it will filter out scores above the threshold distance. This threshold applies before weight and bias modifications. If not specified, this defaults to no threshold. A threshold of 0 will default to no threshold.

search_type: SearchTypeTrue

This is the search method used when searching for relevant chunks from the vector store.

Implementations

impl TrieveKnowledgeBaseSearchPlan

pub fn new(search_type: SearchTypeTrue) -> TrieveKnowledgeBaseSearchPlan

Trait Implementations

impl Clone for TrieveKnowledgeBaseSearchPlan

fn clone(&self) -> TrieveKnowledgeBaseSearchPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrieveKnowledgeBaseSearchPlan

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

Formats the value using the given formatter.

impl Default for TrieveKnowledgeBaseSearchPlan

fn default() -> TrieveKnowledgeBaseSearchPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrieveKnowledgeBaseSearchPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TrieveKnowledgeBaseSearchPlan

fn eq(&self, other: &TrieveKnowledgeBaseSearchPlan) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TrieveKnowledgeBaseSearchPlan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TrieveKnowledgeBaseSearchPlan