Interface VectorIndex<M>

Readonlydimensions

Readonlysize

add

• add(items: IndexItem<M> | IndexItem<M>[]): Promise<void>

  Parameters

  • items: IndexItem<M> | IndexItem<M>[]

  Returns Promise<void>

clear

• clear(): Promise<void>

  Returns Promise<void>

pairs

• pairs(
      o?: { minScore?: number },
  ): Promise<{ a: string; b: string; score: number }[]>

  Near-duplicate pairs above a similarity threshold.

  Parameters

  • Optionalo: { minScore?: number }

  Returns Promise<{ a: string; b: string; score: number }[]>

query

• query(text: string, o?: { k?: number; minScore?: number }): Promise<Hit<M>[]>

  Embed a query with the index's model and search.

  Parameters

  • text: string
  • Optionalo: { k?: number; minScore?: number }

  Returns Promise<Hit<M>[]>

remove

• remove(id: string): Promise<boolean>

  Parameters

  • id: string

  Returns Promise<boolean>

save

• save(): Promise<void>

  Write the index to disk (server) or the Origin Private File System (browser).

  Returns Promise<void>

search

• search(
      query: Float32Array,
      o?: { k?: number; minScore?: number },
  ): Promise<Hit<M>[]>

  Parameters

  • query: Float32Array
  • Optionalo: { k?: number; minScore?: number }

  Returns Promise<Hit<M>[]>