Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/embedder-transformersjs / TransformersJsEmbedderOptions
Interface: TransformersJsEmbedderOptions
Defined in: packages/embedder-transformersjs/src/index.ts:31
Configuration accepted by createTransformersJsEmbedder.
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
cacheDir? | readonly | string | Optional cache directory. When unset, the embedder honours process.env.GRAPHORIN_CACHE_DIR, otherwise falls back to the Hugging Face default (os.homedir()/.cache/huggingface/hub). | packages/embedder-transformersjs/src/index.ts:45 |
device? | readonly | string | Override device ('cpu', 'webgpu', …). Default 'cpu'. | packages/embedder-transformersjs/src/index.ts:52 |
dim? | readonly | number | Optional dimensionality hint. When the caller knows the output dimension up-front, it is included in the canonical id without waiting for the first embed() call. | packages/embedder-transformersjs/src/index.ts:64 |
dtype? | readonly | string | Optional dtype hint (`'fp32' | 'fp16' |
model? | readonly | string | Default 'Xenova/multilingual-e5-base' (768-dim). | packages/embedder-transformersjs/src/index.ts:33 |
normalize? | readonly | boolean | Default true. | packages/embedder-transformersjs/src/index.ts:37 |
pipelineFactory? | readonly | PipelineFactory | Override the underlying pipeline factory — used by the test suite to inject a stub. Production callers should leave this unset so the package lazily loads @huggingface/transformers. | packages/embedder-transformersjs/src/index.ts:58 |
pooling? | readonly | Pooling | Default 'mean'. | packages/embedder-transformersjs/src/index.ts:35 |
revision? | readonly | string | Optional model revision pin ('main' if unset). | packages/embedder-transformersjs/src/index.ts:39 |