Graphorin

Appearance

Graphorin API reference v0.1.0

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

Class: TransformersJsEmbedder ​

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

EmbedderProvider implementation backed by @huggingface/transformers.

Stable ​

Implements ​

Constructors ​

Constructor ​

ts
new TransformersJsEmbedder(options): TransformersJsEmbedder;

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

Parameters ​

ParameterType
optionsTransformersJsEmbedderOptions

Returns ​

TransformersJsEmbedder

Methods ​

configHash() ​

ts
configHash(): string;

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

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:155

Output dimensionality of the embedding vectors.

Returns ​

number

Implementation of ​

EmbedderProvider.dim

embed() ​

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

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

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:150

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

Returns ​

string

Implementation of ​

EmbedderProvider.id