Function: useColbertEmbedder()

useColbertEmbedder(config, options?): object

Defined in: hooks/useColbertEmbedder.ts:25

React hook to load and run a late-interaction (ColBERT) embedding model.

This hook manages downloading (if remote URLs are provided) and loading the model assets and tokenizer files, tracking download progress and load errors, and releasing native memory when the component unmounts or the configuration changes.

For imperative usage, see createColbertEmbedder.

Parameters

config

ColbertEmbedderModel

The ColBERT embedder model configuration. See ColbertEmbedderModel.

options?

ResourceOptions

Load and caching options. See ResourceOptions.

Returns

object

The same object as ColbertEmbedder (without dispose), combined with loading state and download progress.

downloadProgress

downloadProgress: any

embed

embed: any = model.embed

embedWorklet

embedWorklet: any = model.embedWorklet

error

error: any

isReady

isReady: boolean = !!model

maxSim

maxSim: any = model.maxSim

resource

resource: any

See

ColbertEmbedder