---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions.md
description: >-
  Constructor options for {@link
  @nhtio/adk/batteries/generation/transformers_js/adapter!TransformersJsGenerationAdapter}.
---

# Interface: TransformersJsGenerationAdapterOptions

Defined in: [src/batteries/generation/transformers\_js/types.ts:178](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L178)

Constructor options for [@nhtio/adk/batteries/generation/transformers\_js/adapter!TransformersJsGenerationAdapter](../../adapter/classes/TransformersJsGenerationAdapter.md).

## Remarks

Extends [BaseGenerationAdapterOptions](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md) (required `model`, e.g.
`onnx-community/Janus-Pro-1B-ONNX` — no default) with the transformers.js Janus knobs.

**EXPERIMENTAL:** this engine downloads/runs a ~2GB multimodal model and takes minutes per image on
WASM/CPU. There is no WebGPU requirement (transformers.js auto-selects the ONNX Runtime execution
provider), but expect this to be materially slower than the OpenAI/Gemini engines.

## Extends

* [`BaseGenerationAdapterOptions`](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md).[`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)

## Properties

| Property                                                     | Type                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                                                                                             | Defined in                                                                                                                                                          |
| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  `chatTemplate?`           | `string`                                                                                                       | Default Janus chat template name forwarded to the processor call (e.g. `'text_to_image'`), applied when a call omits its own.                                                                                                                                                                                                                                                                     | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:226](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L226) |
|  `createModel?`             | [`CreateTransformersJsGenerationModel`](../type-aliases/CreateTransformersJsGenerationModel.md)                | Override the model factory. Default: `MultiModalityCausalLM.from_pretrained(model, …)` via dynamic import.                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L189) |
|  `createProcessor?`     | [`CreateTransformersJsGenerationProcessor`](../type-aliases/CreateTransformersJsGenerationProcessor.md)        | Override the processor factory. Default: `AutoProcessor.from_pretrained(model, …)` via dynamic import.                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:191](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L191) |
|  `device?`                       | `string`                                                                                                       | Inference device forwarded to `from_pretrained()`. Default: transformers.js environment default.                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L193) |
|  `doSample?`                   | `boolean`                                                                                                      | Default sampling knobs applied when a `generate()` call omits its own — see [TransformersJsGenerateOptions](TransformersJsGenerateOptions.md) for the per-knob provenance/verification notes.                                                                                                                                                                                                     | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:216](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L216) |
|  `dtype?`                         | `string`                                                                                                       | Quantization/precision dtype forwarded to `from_pretrained()`.                                                                                                                                                                                                                                                                                                                                    | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L195) |
|  `encodeImage?`             | [`EncodeRawImageFn`](../type-aliases/EncodeRawImageFn.md)                                                      | Test/runtime seam overriding how a resolved `RawImage`-like value is encoded to PNG bytes — see [EncodeRawImageFn](../type-aliases/EncodeRawImageFn.md). Short-circuits the env-branch (`toBlob`/`toSharp`) entirely; the primary hermetic-test seam for `generate()`.                                                                                                                            | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:211](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L211) |
|  `guidanceScale?`         | `number`                                                                                                       | Default classifier-free-guidance scale (`guidance_scale`; CFG activates when `> 1`), applied when a call omits its own.                                                                                                                                                                                                                                                                           | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:222](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L222) |
|  `isAvailable?`             | () => `boolean`                                                                                                | Override the availability probe. Default: `true` whenever the peer is importable (env-neutral).                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:205](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L205) |
|  `janusModel?`               | [`TransformersJsGenerationModel`](TransformersJsGenerationModel.md)                                            | A pre-built Janus model. When provided, the battery uses it directly and skips lazy creation. Named `janusModel` (not `model`) because `model` (from [BaseGenerationAdapterOptions](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md)) is already the model **id** string.                                                                                                        | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L185) |
|  `model`                          | `string`                                                                                                       | Model id to generate/edit images with. **Required, no default.** For OpenAI this is e.g. `gpt-image-1` or `dall-e-3`.                                                                                                                                                                                                                                                                             | [`BaseGenerationAdapterOptions`](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md).[`model`](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md#property-model)                              | [src/batteries/generation/openai/types.ts:71](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/openai/types.ts#L71)                     |
|  `modelSource?`             | [`TransformersJsGenerationModelSource`](../type-aliases/TransformersJsGenerationModelSource.md)                | Custom model-source resolver (OPFS / separate source / bundled bytes). When set, model files load through it behind the global-`env` mutex; otherwise straight from HF (unchanged). See [TransformersJsGenerationModelSource](../type-aliases/TransformersJsGenerationModelSource.md).                                                                                                            | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L201) |
|  `onCompiling?`             | [`BatteryLifecycleCallback`](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | Engine/graph/shader compilation after download, before the first token. A COARSE marker: the on-device runtimes (LiteRT `Engine.create`, transformers.js `from_pretrained`) expose the boundary — download done, opaque WebGPU/WASM graph build about to run — but NOT a progress stream, so `progress` is usually absent. Often the slowest part of a cold start; without this it was invisible. | [`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onCompiling`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-oncompiling)   | [src/batteries/llm/chat\_common/lifecycle.ts:95](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95)                 |
|  `onComplete?`               | [`BatteryLifecycleCallback`](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | After the turn's output is parsed + persisted, before `ack` (fires per turn).                                                                                                                                                                                                                                                                                                                     | [`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onComplete`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-oncomplete)     | [src/batteries/llm/chat\_common/lifecycle.ts:105](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105)               |
|  `onError?`                     | [`BatteryLifecycleCallback`](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | A load or generation failure (paired with `nack`).                                                                                                                                                                                                                                                                                                                                                | [`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onError`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onerror)           | [src/batteries/llm/chat\_common/lifecycle.ts:107](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107)               |
|  `onGenerating?`           | [`BatteryLifecycleCallback`](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | The generate call is in progress (fires per turn). Fires once immediately before the provider call for most engines; engines that stream per-step generation progress (e.g. a diffusion denoise loop) fire it REPEATEDLY during generation, each carrying a `progress` in `0..1`.                                                                                                                 | [`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onGenerating`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-ongenerating) | [src/batteries/llm/chat\_common/lifecycle.ts:103](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103)               |
|  `onInitProgress?`       | [`TransformersJsGenerationProgressCallback`](../type-aliases/TransformersJsGenerationProgressCallback.md)      | Called with model-load progress reports while weights download/compile.                                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:203](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L203) |
|  `onLifecycle?`             | [`BatteryLifecycleCallback`](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | Fires on EVERY phase transition (the firehose).                                                                                                                                                                                                                                                                                                                                                   | [`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onLifecycle`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onlifecycle)   | [src/batteries/llm/chat\_common/lifecycle.ts:86](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86)                 |
|  `onLoading?`                 | [`BatteryLifecycleCallback`](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | Weights/runtime loading — may fire repeatedly with `progress` as the provider reports it.                                                                                                                                                                                                                                                                                                         | [`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onLoading`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onloading)       | [src/batteries/llm/chat\_common/lifecycle.ts:88](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88)                 |
|  `onReady?`                     | [`BatteryLifecycleCallback`](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | Engine/pipeline resolved and cached, before the first generation.                                                                                                                                                                                                                                                                                                                                 | [`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onReady`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onready)           | [src/batteries/llm/chat\_common/lifecycle.ts:97](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97)                 |
|  `processor?`                 | [`TransformersJsGenerationProcessor`](TransformersJsGenerationProcessor.md)                                    | A pre-built Janus processor. When provided, the battery uses it directly and skips lazy creation.                                                                                                                                                                                                                                                                                                 | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L187) |
|  `repetitionPenalty?` | `number`                                                                                                       | Default repetition penalty (`repetition_penalty`), applied when a call omits its own.                                                                                                                                                                                                                                                                                                             | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:224](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L224) |
|  `role?`                           | `string`                                                                                                       | Default conversation role used to build the single-turn prompt (Janus convention: `'<                                                                                                                                                                                                                                                                                                             | User                                                                                                                                                                                                                       | >'`).                                                                                                                                                               | -   | [src/batteries/generation/transformers\_js/types.ts:228](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L228) |
|  `temperature?`             | `number`                                                                                                       | Default sampling temperature (`temperature`), applied when a call omits its own.                                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:218](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L218) |
|  `topK?`                           | `number`                                                                                                       | Default top-k cutoff (`top_k`), applied when a call omits its own.                                                                                                                                                                                                                                                                                                                                | -                                                                                                                                                                                                                          | [src/batteries/generation/transformers\_js/types.ts:220](https://github.com/NHTIO/ADK/blob/v1.20261103.0/src/src/batteries/generation/transformers_js/types.ts#L220) |
