Graphorin API reference v0.12.1
Graphorin API reference / @graphorin/embedder-transformersjs / / TransformersJsEmbedder
Class: TransformersJsEmbedder
Defined in: packages/embedder-transformersjs/src/index.ts:137
EmbedderProvider implementation backed by @huggingface/transformers.
Stable
Implements
Constructors
Constructor
new TransformersJsEmbedder(options): TransformersJsEmbedder;Defined in: packages/embedder-transformersjs/src/index.ts:152
Parameters
| Parameter | Type |
|---|---|
options | TransformersJsEmbedderOptions |
Returns
TransformersJsEmbedder
Methods
configHash()
configHash(): string;Defined in: packages/embedder-transformersjs/src/index.ts:188
Stable hash of the embedder's configuration (model + revision + opts).
Returns
string
Implementation of
dim()
dim(): number;Defined in: packages/embedder-transformersjs/src/index.ts:179
Output dimension - the explicit dim option, a known-model default, or the width resolved from the first embed(). periphery-05 (the PS-11 fix ported from the Ollama embedder): 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
embed()
embed(texts, opts?): Promise<readonly Float32Array<ArrayBufferLike>[]>;Defined in: packages/embedder-transformersjs/src/index.ts:204
Compute embeddings for a batch of texts. Returns one vector per text.
Parameters
| Parameter | Type |
|---|---|
texts | readonly string[] |
opts | EmbedOptions |
Returns
Promise<readonly Float32Array<ArrayBufferLike>[]>
Implementation of
id()
id(): string;Defined in: packages/embedder-transformersjs/src/index.ts:165
Stable identifier (e.g. 'transformersjs:Xenova/multilingual-e5-base').
Returns
string