SemanticIndex¶

An exact in-memory semantic index.

Constructors¶

new SemanticIndex(): SemanticIndex;

SemanticIndex

get length(): number;

number

add(ids, texts): Promise<void>;

Parameter	Type
`ids`	`string`[]
`texts`	`string`[]

Promise\<void>

remove(id): boolean;

Parameter	Type
`id`	`string`

boolean

save(path): Promise<void>;

Parameter	Type
`path`	`string`

Promise\<void>

search(query, k?): Promise<SemanticHit[]>;

Parameter	Type
`query`	`string`
`k?`	`number` \| `null`

Promise\<SemanticHit[]>

static create(embedder): SemanticIndex;

An empty index over a loaded embedder: SemanticIndex.create(await LocalEmbedder.load()).

Parameter	Type
`embedder`	`LocalEmbedder`

SemanticIndex

static load(path, embedder): SemanticIndex;

Loads a saved index; it must have been built with the same model pack.

Parameter	Type
`path`	`string`
`embedder`	`LocalEmbedder`

SemanticIndex