Skip to main content

KnowledgeBase

Struct KnowledgeBase 

Source
pub struct KnowledgeBase { /* private fields */ }
Expand description

Dataset id -> retriever registry.

Implementations§

Source§

impl KnowledgeBase

Source

pub fn new() -> Self

Source

pub fn with_store_dataset( self, id: impl Into<String>, store: Arc<dyn VectorStore>, embedder: Arc<dyn Embedder>, reranker: Option<Arc<dyn Reranker>>, ) -> Self

Add a dataset backed by the built-in store pipeline.

Source

pub fn add_store_dataset( &mut self, info: DatasetInfo, store: Arc<dyn VectorStore>, embedder: Arc<dyn Embedder>, reranker: Option<Arc<dyn Reranker>>, ) -> &mut Self

Add (or replace) a store-backed dataset with descriptive info.

Source

pub fn with_retriever( self, id: impl Into<String>, retriever: Arc<dyn Retriever>, ) -> Self

Add a dataset served by an external retriever.

Source

pub fn add_retriever( &mut self, info: DatasetInfo, retriever: Arc<dyn Retriever>, ) -> &mut Self

Add (or replace) a dataset served by an external retriever.

Source

pub fn with_reranker(self, reranker: Option<Arc<dyn Reranker>>) -> Self

Reranker applied to the merged results of multi-dataset retrieval.

Source

pub fn datasets(&self) -> impl Iterator<Item = &DatasetInfo>

Source

pub fn contains(&self, dataset_id: &str) -> bool

Source

pub fn ingestor(&self, dataset_id: &str) -> Option<Ingestor>

An ingestor for a store-backed dataset (None for external retrievers or unknown ids).

Source

pub async fn retrieve( &self, request: &RetrievalRequest, ) -> Result<Vec<Hit>, RagError>

Retrieve across all requested datasets and merge by score.

When request.rerank is set and the knowledge base has a cross-dataset reranker, the merged list is reranked as a whole (making scores from different datasets comparable). Otherwise each dataset’s own reranker, if any, is applied before merging.

Source

pub async fn retrieve_single( &self, request: &RetrievalRequest, ) -> Result<Vec<Hit>, RagError>

Retrieve from the single best-matching dataset: every dataset is queried, and only the hits of the dataset whose top hit scores highest are kept.

Trait Implementations§

Source§

impl Clone for KnowledgeBase

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KnowledgeBase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for KnowledgeBase

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more