Class WorkerEmbeddings

Implements

EmbeddingsInterface<number[] | Float32Array>

Index

Constructors

Methods

embedDocuments embedDocumentsRaw embedQuery getEmbeddingProvenance terminate

Constructors

constructor

new WorkerEmbeddings(options?: WorkerEmbeddingsOptions): WorkerEmbeddings
Create a WorkerEmbeddings instance.
Parameters
- options: WorkerEmbeddingsOptions = {}
  Worker and runtime options.
Returns WorkerEmbeddings
- Defined in worker/WorkerEmbeddings.ts:68

Methods

embedDocuments

embedDocuments(
documents: string[],
): Promise<(Float32Array<ArrayBufferLike> | number[])[]>
Embed an array of documents.
Parameters
- documents: string[]
  Array of strings to embed.
Returns Promise<(Float32Array<ArrayBufferLike> | number[])[]>
Array of embeddings (number[] or Float32Array).
Implementation of EmbeddingsInterface.embedDocuments
- Defined in worker/WorkerEmbeddings.ts:159

embedDocumentsRaw

embedDocumentsRaw(
documents: string[],
): Promise<{ buffer: ArrayBuffer; dims: number; rows: number }>
Return a packed ArrayBuffer with embeddings laid out row-major (rows * dims). Uses transferred buffer from worker if available, otherwise packs nested arrays.
Parameters
- documents: string[]
  Array of strings to embed.
Returns Promise<{ buffer: ArrayBuffer; dims: number; rows: number }>
Object with buffer, rows, and dims.
- Defined in worker/WorkerEmbeddings.ts:181

embedQuery

embedQuery(document: string): Promise<Float32Array<ArrayBufferLike> | number[]>
Embed a single query/document.
Parameters
- document: string
  String to embed.
Returns Promise<Float32Array<ArrayBufferLike> | number[]>
Embedding (number[] or Float32Array).
Implementation of EmbeddingsInterface.embedQuery
- Defined in worker/WorkerEmbeddings.ts:225

getEmbeddingProvenance

getEmbeddingProvenance(): Promise<string>
Returns Promise<string>
- Defined in worker/WorkerEmbeddings.ts:230

terminate

terminate(): void
Returns void
- Defined in worker/WorkerEmbeddings.ts:143