Skip to content

Graphorin API reference v0.15.1


Graphorin API reference / @graphorin/embedder-transformersjs / / TransformersJsEmbedder

Class: TransformersJsEmbedder ​

Defined in: packages/embedder-transformersjs/src/index.ts:137

Stable

EmbedderProvider implementation backed by @huggingface/transformers.

Implements ​

Constructors ​

Constructor ​

ts
new TransformersJsEmbedder(options): TransformersJsEmbedder;

Defined in: packages/embedder-transformersjs/src/index.ts:152

Parameters ​

ParameterType
optionsTransformersJsEmbedderOptions

Returns ​

TransformersJsEmbedder

Methods ​

configHash() ​

ts
configHash(): string;

Defined in: packages/embedder-transformersjs/src/index.ts:187

Stable hash of the embedder's configuration (model + revision + opts).

Returns ​

string

Implementation of ​

EmbedderProvider.configHash


dim() ​

ts
dim(): number;

Defined in: packages/embedder-transformersjs/src/index.ts:178

Output dimension - the explicit dim option, a known-model default, or the width resolved from the first embed(). Like the Ollama embedder, this throws for an unknown model with no dim hint instead of silently assuming 768 - a wrong assumed width bakes a wrong-width id AND a wrong-width vec0 table, and the id then CHANGES after the first embed() resolves the truth, which lock-on-first reads as an embedder swap.

Returns ​

number

Implementation of ​

EmbedderProvider.dim


embed() ​

ts
embed(texts, opts?): Promise<readonly Float32Array<ArrayBufferLike>[]>;

Defined in: packages/embedder-transformersjs/src/index.ts:203

Compute embeddings for a batch of texts. Returns one vector per text.

Parameters ​

ParameterType
textsreadonly string[]
optsEmbedOptions

Returns ​

Promise<readonly Float32Array&lt;ArrayBufferLike&gt;[]>

Implementation of ​

EmbedderProvider.embed


id() ​

ts
id(): string;

Defined in: packages/embedder-transformersjs/src/index.ts:165

Stable identifier (e.g. 'transformersjs:Xenova/multilingual-e5-base').

Returns ​

string

Implementation of ​

EmbedderProvider.id