Skip to main content

KnowledgeIndex

Struct KnowledgeIndex 

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

In-memory, term-indexed knowledge base built from ingested documents.

Retrieval is based on IDF-weighted token overlap: content words that appear rarely across the corpus are weighted more heavily, focusing results on discriminative evidence.

§Examples

use lmm_agent::cognition::knowledge::KnowledgeIndex;

let mut idx = KnowledgeIndex::new();
idx.ingest_text(
    "rust-book",
    "Rust prevents data races at compile time through its ownership model.",
);
let hits = idx.query("What prevents data races in Rust?", 3);
assert!(!hits.is_empty());

Implementations§

Source§

impl KnowledgeIndex

Source

pub fn new() -> Self

Creates an empty KnowledgeIndex.

Source

pub fn is_empty(&self) -> bool

Returns true if no documents have been ingested yet.

Source

pub fn len(&self) -> usize

Returns the total number of indexed chunks.

Source

pub fn ingest_text(&mut self, source: &str, text: &str) -> usize

Ingests a raw text string under the given source label.

The text is split into sentence-level chunks via a lightweight sentence splitter before being indexed. Returns the number of chunks created.

Source

pub fn query(&self, question: &str, top_k: usize) -> Vec<&DocumentChunk>

Returns the top_k most relevant DocumentChunks for question.

Chunks are scored by the sum of IDF weights for each question token that appears in the chunk.

Source

pub fn answer(&self, question: &str, top_k: usize) -> Option<String>

Returns an extractive answer to question from the knowledge base, or None if no relevant chunks are found.

The top-top_k chunks are concatenated and passed to lmm::text::TextSummarizer with the original question as a relevance hint. The summariser selects the sentences most likely to answer the question.

Trait Implementations§

Source§

impl Clone for KnowledgeIndex

Source§

fn clone(&self) -> KnowledgeIndex

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KnowledgeIndex

Source§

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

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

impl Default for KnowledgeIndex

Source§

fn default() -> KnowledgeIndex

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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