Class ExecuTorchEmbeddings

ExecuTorch-based implementation of Embeddings for React Native.

Implements

Embeddings

Index

Constructors

Methods

embed load unload

Constructors

constructor

new ExecuTorchEmbeddings(
params: ExecuTorchEmbeddingsParams,
): ExecuTorchEmbeddings
Creates a new ExecuTorch embeddings instance.
Parameters
- params: ExecuTorchEmbeddingsParams
  Parameters for the instance.
  - modelSource
    Source of the embedding model.
  - tokenizerSource
    Source of the tokenizer.
  - onDownloadProgress
    Download progress callback (0-1).
Returns ExecuTorchEmbeddings

Methods

embed

embed(text: string): Promise<number[]>
Generates an embedding vector for the given text.
Parameters
- text: string
  Input string to embed.
Returns Promise<number[]>
Promise that resolves to the embedding vector.

Implementation of Embeddings.embed

load

load(): Promise<ExecuTorchEmbeddings>
Loads model and tokenizer via react-native-executorch.

Returns Promise<ExecuTorchEmbeddings>
Promise that resolves to the same instance.

Implementation of Embeddings.load

unload

unload(): Promise<void>
Unloads the underlying module. Note: current ExecuTorch unload is synchronous. Awaiting this method will not guarantee completion.

Returns Promise<void>
Implementation of Embeddings.unload