Skip to main content

Interface: LibraryGroupResult

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:266

One group's answer.

Properties​

anyWord​

anyWord: LibraryGroupHit[]

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:288

On a first page of two words or more where no item matches every word: the items that match some of them, at most pageSize, outside total and with no cursor.


cursor​

cursor: string | null

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:282

What the next page takes as cursor, or null after the last.


hits​

hits: LibraryGroupHit[]

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:283


id​

id: string

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:267


incomplete​

incomplete: boolean

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:280

True when a word had more stored words one edit away than expansionMax, or than the store's query holds, on the page that read them and on every page after it, the hits then matching the ones kept; or when the signal stopped the search, the group then holding no hit.


state​

state: "ok" | "restart"

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:272

restart when the cursor was made under another fingerprint than the group's, or under another scope: what the search may read changed between two pages, nothing is answered, and the caller searches again from the first page.


total​

total: number

Defined in: packages/agentos/src/cognition/library/LibraryIndex.ts:274

How many distinct items match every word, whatever the page; in a listing, how many hold a passage.