Skip to main content

Interface: LexicalGroupRow

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:349

One item a grouped lexical search found.

Properties​

document​

document: RetrievedVectorDocument

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:374

The passage to show, with its metadata and text: the one that holds the most words, then the one of the strongest field, then the earliest; the item's first passage when no passage holds a word (a listing, or a match in a title read from the metadata alone).


field​

field: string

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:363

The field of the match shown: document's field as the rank read it (its field metadata key, or the profile's fallback when it has none or the profile does not name it), or the title's field when no passage holds a word and the item matched by its title read from the metadata.


held​

held: (LexicalMatchKind | null)[]

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:376

For each word, in order, how document holds it, or null when it does not.


kinds​

kinds: (LexicalMatchKind | null)[]

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:368

For each word, in order, the kind of the item's best match of it, over its passages and its title read from the metadata, or null for a word the item does not hold.


rank​

rank: string

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:357

The item's rank as exact decimal text: for each word, the best of its matches over the item's passages, the weight of the passage's field times the match's kind (the same word 1, a word it begins 0.75, a word one edit away 0.5), summed over the words. 0 in a listing with no word.


sourceId​

sourceId: string

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:351

The item's source id.