Class ExactRetrievalIndex<TFeatures>

constructor

• new ExactRetrievalIndex<TFeatures extends Record<string, unknown>>(
      domain: string,
      schemaVersion: string,
      indexVersion?: string,
  ): ExactRetrievalIndex<TFeatures>

  Type Parameters

  • TFeatures extends Record<string, unknown>

  Parameters

  • domain: string
  • schemaVersion: string
  • indexVersion: string = "exact.v1"

  Returns ExactRetrievalIndex<TFeatures>

Readonlydomain

ReadonlyindexVersion

ReadonlyschemaVersion

add

• add(observation: Observation<TFeatures>): Promise<string>

  Parameters

  • observation: Observation<TFeatures>

  Returns Promise<string>

all

• all(): readonly RetrievalResult<TFeatures>[]

  Returns readonly RetrievalResult<TFeatures>[]

clear

• clear(): void

  Returns void

findExact

• findExact(
      features: TFeatures,
      limit?: number,
  ): Promise<readonly RetrievalResult<TFeatures>[]>

  Parameters

  • features: TFeatures
  • limit: number = Number.MAX_SAFE_INTEGER

  Returns Promise<readonly RetrievalResult<TFeatures>[]>

manifest

• manifest(): RetrievalIndexManifest

  Returns RetrievalIndexManifest

page

• page(offset: number, limit: number): readonly RetrievalResult<TFeatures>[]

  Parameters

  • offset: number
  • limit: number

  Returns readonly RetrievalResult<TFeatures>[]

rebuild

• rebuild(
      observations: readonly Observation<TFeatures>[],
  ): Promise<RetrievalIndexManifest>

  Parameters

  • observations: readonly Observation<TFeatures>[]

  Returns Promise<RetrievalIndexManifest>

remove

• remove(observationId: string): boolean

  Parameters

  • observationId: string

  Returns boolean

restore

• restore(snapshot: RetrievalSnapshot<TFeatures>): Promise<void>

  Parameters

  • snapshot: RetrievalSnapshot<TFeatures>

  Returns Promise<void>

snapshot

• snapshot(): RetrievalSnapshot<TFeatures>

  Returns RetrievalSnapshot<TFeatures>