IAsyncSimilarityIndex
Defined in: packages/data/src/similarity/iasync-similarity-index.ts:2
The async-backed sibling of ISimilarityIndex.
Type Parameters
Section titled “Type Parameters”T
Methods
Section titled “Methods”add(
item,signal?):Promise<void>
Defined in: packages/data/src/similarity/iasync-similarity-index.ts:3
Parameters
Section titled “Parameters”T
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
addAll()
Section titled “addAll()”addAll(
items,signal?):Promise<void>
Defined in: packages/data/src/similarity/iasync-similarity-index.ts:4
Parameters
Section titled “Parameters”Iterable<T>
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
nearest()
Section titled “nearest()”nearest(
query,count,signal?):AsyncIterableIterator<readonly [T,number]>
Defined in: packages/data/src/similarity/iasync-similarity-index.ts:5
Parameters
Section titled “Parameters”T
number
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<readonly [T, number]>
within()
Section titled “within()”within(
query,maxDistance,signal?):AsyncIterableIterator<readonly [T,number]>
Defined in: packages/data/src/similarity/iasync-similarity-index.ts:10
Parameters
Section titled “Parameters”T
maxDistance
Section titled “maxDistance”number
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<readonly [T, number]>