Function: useTextEmbedder()

useTextEmbedder(config, options?): object

Defined in: hooks/useTextEmbedder.ts:22

React hook to load and run a text 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 createTextEmbedder.

Parameters

config

TextEmbedderModel

The text embedder model configuration. See TextEmbedderModel.

options?

ResourceOptions

Load and caching options. See ResourceOptions.

Returns

object

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

downloadProgress

downloadProgress: number

embed

embed: (input, prompt?) => Promise<Float32Array<ArrayBufferLike>> | undefined = model.embed

embedWorklet

embedWorklet: (input, prompt?) => Float32Array | undefined = model.embedWorklet

error

error: Error | undefined

isReady

isReady: boolean = !!model

resource

resource: TextEmbedderModel | undefined

See

TextEmbedder